Skip to content

gguf.md: add sharding to naming convention #826

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
May 19, 2024
Merged

gguf.md: add sharding to naming convention #826

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c0f25bf
gguf.md: add sharding to naming convention [no ci]
mofosyne May 17, 2024
0b3cbe4
gguf.md: Add note on using gguf metadata for model name, version and …
mofosyne May 17, 2024
4445a51
gguf.md: Tighten up wording and add regex example [no ci]
mofosyne May 18, 2024
25d5656
gguf.md: json output for expertcount and shard is numerical [no ci]
mofosyne May 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions docs/gguf.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The key difference between GGJT and GGUF is the use of a key-value structure for

### GGUF Naming Convention

GGUF follow a naming convention of `<Model>-<Version>-<ExpertsCount>x<Parameters>-<EncodingScheme>.gguf`
GGUF follow a naming convention of `<Model>-<Version>-<ExpertsCount>x<Parameters>-<EncodingScheme>-<Shard>.gguf`

The components are:
1. **Model**: A descriptive name for the model type or architecture.
Expand All @@ -34,6 +34,10 @@ The components are:
- `M`: Million parameters.
- `K`: Thousand parameters.
5. **EncodingScheme**: Indicates the weights encoding scheme that was applied to the model. Content, type mixture and arrangement however are determined by user code and can vary depending on project needs.
6. **Shard**: (Optional) Indicates and denotes that the model has been split into multiple shards, formatted as `<ShardNum>-of-<ShardTotal>`.
- *ShardNum* : Shard position in this model. Must be 5 digits padded by zeros.
- Shard number always starts from `00001` onwards (e.g. First shard always starts at `00001-of-XXXXX` rather than `00000-of-XXXXX`).
- *ShardTotal* : Total number of shards in this model. Must be 5 digits padded by zeros.

#### Parsing Above Naming Convention

Expand All @@ -47,13 +51,24 @@ For example:
- Expert Count: 8
- Parameter Count: 7B
- Weight Encoding Scheme: KQ2
- Shard: N/A

* `Hermes-2-Pro-Llama-3-8B-F16.gguf`:
- Model Name: Hermes 2 Pro Llama 3
- Version Number: v0.0 (`<Version>-` missing)
- Expert Count: 0 (`<ExpertsCount>x` missing)
- Version Number: v0.0
- Expert Count: 0
- Parameter Count: 8B
- Weight Encoding Scheme: F16
- Shard: N/A

* `grok-v1.0-100B-Q4_0-00003-of-00009.gguf"`
- Model Name: Grok
- Version Number: v1.0
- Expert Count: 0
- Parameter Count: 100B
- Weight Encoding Scheme: Q4_0
- Shard: 3 out of 9 total shards


### File Structure

Expand Down