Skip to content

Commit 8b78e63

Browse files
merveenoyanpcuencaVaibhavs10
authored
Update model release checklist (#1724)
--------- Co-authored-by: Pedro Cuenca <[email protected]> Co-authored-by: vb <[email protected]>
1 parent 5ffced1 commit 8b78e63

File tree

1 file changed

+6
-1
lines changed

1 file changed

+6
-1
lines changed

docs/hub/model-release-checklist.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,13 +63,16 @@ We wrote an extensive guide on uploading best practices [here](https://huggingfa
6363

6464
Bonus: a recognised library also allows you to track downloads of your model over time.
6565

66-
2. **Pipeline Tag Selection**: Choose the correct [pipeline tag](https://huggingface.co/docs/hub/model-cards#specifying-a-task--pipelinetag-) that accurately reflects your model's primary task. This tag determines how your model appears in search results and which widgets are displayed on your model page.
66+
2. **Correct Metadata**:
67+
- **Pipeline Tag:** Choose the correct [pipeline tag](https://huggingface.co/docs/hub/model-cards#specifying-a-task--pipelinetag-) that accurately reflects your model's primary task. This tag determines how your model appears in search results and which widgets are displayed on your model page.
6768

6869
Examples of common pipeline tags:
6970
- `text-generation` - For language models that generate text
7071
- `text-to-image` - For text-to-image generation models
7172
- `image-text-to-text` - For vision-language models (VLMs) that generate text
7273
- `text-to-speech` - For models that generate audio from text
74+
75+
- **License:** License information is crucial for users to understand how they can use the model.
7376

7477
3. **Research Papers**: If your model has associated research papers, you can cite them in your model card and they will be [linked automatically](https://huggingface.co/docs/hub/model-cards#linking-a-paper). This provides academic context, allows users to dive deeper into the theoretical foundations of your work, and increases citations.
7578

@@ -88,6 +91,8 @@ Bonus: a recognised library also allows you to track downloads of your model ove
8891

8992
Try this model directly in your browser: [Space Demo](https://huggingface.co/spaces/username/model-demo)
9093
```
94+
95+
When you create a demo, please download the model from its repository on the Hub (instead of using external sources like Google Drive); it cross-links model artefacts and demo together and allows more paths to visibility.
9196

9297
6. **Quantized Versions**: Consider uploading quantized versions of your model (e.g., in GGUF or DDUF formats) to improve accessibility for users with limited computational resources. Link these versions using the [`base_model` metadata field](https://huggingface.co/docs/hub/model-cards#specifying-a-base-model) on the quantized model cards. You can also clearly document performance differences between the original and quantized versions.
9398

0 commit comments

Comments
 (0)