You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/gguf.md
+23-3Lines changed: 23 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -20,12 +20,12 @@ The key difference between GGJT and GGUF is the use of a key-value structure for
20
20
21
21
### GGUF Naming Convention
22
22
23
-
GGUF follow a naming convention of `<Model>-<Version>-<ExpertsCount>x<Parameters>-<Quantization>.gguf`.
23
+
GGUF follow a naming convention of `<Model>-<Version>-<ExpertsCount>x<Parameters>-<Quantization>.gguf`
24
24
25
25
The components are:
26
26
1.**Model**: A descriptive name for the model type or architecture.
27
-
2.**Version (Optional)**: Denotes the model version number, starting at `v1` if not specified, formatted as `v<Major>.<Minor>`.
28
-
-Best practice to include model version number only if model has multiple versions and assume the unversioned model to be the first version and/or check the model card.
27
+
2.**Version**: (Optional) Denotes the model version number, formatted as `v<Major>.<Minor>`
28
+
-If model is missing a version number then assume `v0.0` (Prerelease)
29
29
3.**ExpertsCount**: Indicates the number of experts found in a Mixture of Experts based model.
30
30
4.**Parameters**: Indicates the number of parameters and their scale, represented as `<count><scale-prefix>`:
31
31
-`T`: Trillion parameters.
@@ -45,6 +45,26 @@ The components are:
45
45
- Even Number (0 or 2): `<model weights> = <scaling factor> * <quantised weight>`
46
46
- Odd Number (1 or 3): `<model weights> = <offset factor> + <scaling factor> * <quantised weight>`
47
47
48
+
#### Parsing Above Naming Convention
49
+
50
+
To correctly parse a well formed naming convention based gguf filename, it is recommended to read from right to left using `-` as the delimiter. This strategy allow for the most flexibility in model name to include dashes if they so choose, while at the same time allowing for version string to be optional. This approach also gives some future proofing to extend the format if needed in the future.
0 commit comments