Mirrors/llama.cpp
1
0
Fork 0
mirror of https://github.com/ggerganov/llama.cpp.git synced 2024-11-25 09:29:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

Created HuggingFace Model Card Metadata Interoperability Consideration (markdown)

Brian 2024-11-21 01:37:59 +11:00
parent f700ab37e0
commit 94f0ab460d
1 changed files with 39 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
HuggingFace-Model-Card-Metadata-Interoperability-Consideration.md Normal file

@ -0,0 +1,39 @@
Below is the agreed upon mapping between GGUF KV Keys and Hugging face as per [Discussion with HF to coordinate on extending the handling of base model sources and dataset sources](https://github.com/huggingface/huggingface_hub/issues/2479).
| **GGUF KV Key** | **HF Model Card Field** | **Notes** |
|----------------------------------------|-------------------------------------|---------------------------------------------------------------------------|
| `general.name` | `model_name` | Name of the model. |
| `general.license` | `license` | License identifier. |
| `general.license.name` | `license_name` | Full name of the license. |
| `general.license.link` | `license_link` | URL to the license text. |
| `general.base_model.{id}.name` | `base_model` | Simpler field: array of model IDs on HF Hub. |
| `general.base_model.{id}.name` | `base_model_sources[].name` | Extension: detailed description of base models. |
| `general.base_model.{id}.author` | `base_model_sources[].author` | Author of the parent/base model (extension field). |
| `general.base_model.{id}.version` | `base_model_sources[].version` | Version of the parent/base model (extension field). |
| `general.base_model.{id}.organization` | `base_model_sources[].organization` | Organization responsible for the parent/base model (extension field). |
| `general.base_model.{id}.description` | `base_model_sources[].description` | Description of the parent/base model (extension field). |
| `general.base_model.{id}.url` | `base_model_sources[].url` | URL for more information about the parent/base model (extension field). |
| `general.base_model.{id}.doi` | `base_model_sources[].doi` | DOI of the parent/base model (extension field). |
| `general.base_model.{id}.uuid` | `base_model_sources[].uuid` | UUID of the parent/base model (extension field). |
| `general.base_model.{id}.repo_url` | `base_model_sources[].repo_url` | Repository URL of the parent/base model (extension field). |
| `general.dataset.{id}.name` | `datasets` | Simpler field: array of dataset IDs on HF Hub. |
| `general.dataset.{id}.name` | `dataset_sources[].name` | Extension: detailed description of datasets. |
| `general.dataset.{id}.author` | `dataset_sources[].author` | Author of the dataset (extension field). |
| `general.dataset.{id}.version` | `dataset_sources[].version` | Version of the dataset (extension field). |
| `general.dataset.{id}.organization` | `dataset_sources[].organization` | Organization responsible for the dataset (extension field). |
| `general.dataset.{id}.description` | `dataset_sources[].description` | Description of the dataset (extension field). |
| `general.dataset.{id}.url` | `dataset_sources[].url` | URL for more information about the dataset (extension field). |
| `general.dataset.{id}.doi` | `dataset_sources[].doi` | DOI of the dataset (extension field). |
| `general.dataset.{id}.uuid` | `dataset_sources[].uuid` | UUID of the dataset (extension field). |
| `general.dataset.{id}.repo_url` | `dataset_sources[].repo_url` | Repository URL of the dataset (extension field). |
| `general.tags` | `tags` | Tags describing the model. |
| `general.languages` | `language` | Languages supported by the model. |
| `general.description` | *Not explicitly mapped for now* | Can be included in a custom "description" field in the model card. |
| `general.url` | *Not explicitly mapped for now* | General URL for further information about the model. |
| `general.repo_url` | *Not explicitly mapped for now* | Repository URL for the model. |
| `general.doi` | *Not explicitly mapped for now* | DOI of the model. |
| `general.uuid` | *Not explicitly mapped for now* | UUID of the model. |
| `general.size_label` | *Not explicitly mapped for now* | May represent quantization or sizing information. |
| `general.quantized_by` | *Not explicitly mapped for now* | Indicates who performed quantization. |
| `general.alignment` | *Not explicitly mapped for now* | Potentially indicates alignment objective (e.g., RLHF, etc.). |
| `general.file_type` | *Not explicitly mapped for now* | File format of the model (e.g., GGUF, Safetensors). |