Skip to content

Commit 43c074c

Browse files
authored
Update model release checklist
1 parent 33ec12b commit 43c074c

File tree

1 file changed

+14
-9
lines changed

1 file changed

+14
-9
lines changed

docs/hub/model-release-checklist.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -63,33 +63,38 @@ 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:** Properly filling the license information in metadata will help users see if they can use the model for commercial or research purposes.
7376

74-
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.
77+
4. **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

7679
```markdown
7780
## References
7881

7982
* [Model Paper](https://arxiv.org/abs/xxxx.xxxxx)
8083
```
8184

82-
4. **Collections**: If you're releasing multiple related models or variants, organize them into a [collection](https://huggingface.co/docs/hub/collections). Collections help users discover related models and understand the relationships between different versions or variants.
85+
5. **Collections**: If you're releasing multiple related models or variants, organize them into a [collection](https://huggingface.co/docs/hub/collections). Collections help users discover related models and understand the relationships between different versions or variants.
8386

84-
5. **Demos**: Create a [Hugging Face Space](https://huggingface.co/docs/hub/spaces) with an interactive demo of your model. This allows users to try your model directly without writing any code, significantly lowering the barrier to adoption. You can also [link the model](https://huggingface.co/docs/hub/spaces-config-reference) from the Space to make it appear on the model page dedicated UI.
87+
6. **Demos**: Create a [Hugging Face Space](https://huggingface.co/docs/hub/spaces) with an interactive demo of your model. This allows users to try your model directly without writing any code, significantly lowering the barrier to adoption. You can also [link the model](https://huggingface.co/docs/hub/spaces-config-reference) from the Space to make it appear on the model page dedicated UI.
8588

8689
```markdown
8790
## Demo
8891

8992
Try this model directly in your browser: [Space Demo](https://huggingface.co/spaces/username/model-demo)
9093
```
94+
95+
It's a good practise to load the model from the model's own repository in the demo instead of loading them from drive or keeping the checkpoint in the repository. This way, Space is linked to the repository, and chances of your model making it to trending is higher due to increased downloads.
9196

92-
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.
97+
7. **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

9499
```yaml
95100
---
@@ -98,7 +103,7 @@ Bonus: a recognised library also allows you to track downloads of your model ove
98103
---
99104
```
100105

101-
7. **Linking Datasets on the Model Page**: Link datasets in your `README.md` metadata to display those used directly from your model page.
106+
8. **Linking Datasets on the Model Page**: Link datasets in your `README.md` metadata to display those used directly from your model page.
102107

103108
```yaml
104109
---
@@ -108,15 +113,15 @@ Bonus: a recognised library also allows you to track downloads of your model ove
108113
---
109114
```
110115

111-
8. **New Model Version**: If your model is an update of an existing one, you can specify it on the older version model model card. This will [display a banner](https://huggingface.co/docs/hub/en/model-cards#specifying-a-new-version) on the older model's page linking directly to this updated version.
116+
9. **New Model Version**: If your model is an update of an existing one, you can specify it on the older version model model card. This will [display a banner](https://huggingface.co/docs/hub/en/model-cards#specifying-a-new-version) on the older model's page linking directly to this updated version.
112117

113118
```yaml
114119
---
115120
new_version: username/updated-model
116121
---
117122
```
118123

119-
9. **Visual Examples**: For image or video generation models, include examples directly on your model page using the [`<Gallery>` card component](https://huggingface.co/docs/hub/en/model-cards-components#the-gallery-component). Visual examples provide immediate insight into your model's capabilities.
124+
10. **Visual Examples**: For image or video generation models, include examples directly on your model page using the [`<Gallery>` card component](https://huggingface.co/docs/hub/en/model-cards-components#the-gallery-component). Visual examples provide immediate insight into your model's capabilities.
120125

121126
```markdown
122127
<Gallery>
@@ -125,7 +130,7 @@ Bonus: a recognised library also allows you to track downloads of your model ove
125130
</Gallery>
126131
```
127132

128-
10. **Carbon Emissions**: If possible, specify the [carbon emissions](https://huggingface.co/docs/hub/model-cards-co2) associated with training your model. This information helps environmentally conscious users and organizations make informed decisions.
133+
11. **Carbon Emissions**: If possible, specify the [carbon emissions](https://huggingface.co/docs/hub/model-cards-co2) associated with training your model. This information helps environmentally conscious users and organizations make informed decisions.
129134

130135
```yaml
131136
---

0 commit comments

Comments
 (0)