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/hub/model-release-checklist.md
+14-9Lines changed: 14 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -63,33 +63,38 @@ We wrote an extensive guide on uploading best practices [here](https://huggingfa
63
63
64
64
Bonus: a recognised library also allows you to track downloads of your model over time.
65
65
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.
67
68
68
69
Examples of common pipeline tags:
69
70
-`text-generation` - For language models that generate text
70
71
-`text-to-image` - For text-to-image generation models
71
72
-`image-text-to-text` - For vision-language models (VLMs) that generate text
72
73
-`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.
73
76
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.
75
78
76
79
```markdown
77
80
## References
78
81
79
82
* [Model Paper](https://arxiv.org/abs/xxxx.xxxxx)
80
83
```
81
84
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.
83
86
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.
85
88
86
89
```markdown
87
90
## Demo
88
91
89
92
Try this model directly in your browser: [Space Demo](https://huggingface.co/spaces/username/model-demo)
90
93
```
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.
91
96
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.
93
98
94
99
```yaml
95
100
---
@@ -98,7 +103,7 @@ Bonus: a recognised library also allows you to track downloads of your model ove
98
103
---
99
104
```
100
105
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.
102
107
103
108
```yaml
104
109
---
@@ -108,15 +113,15 @@ Bonus: a recognised library also allows you to track downloads of your model ove
108
113
---
109
114
```
110
115
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.
112
117
113
118
```yaml
114
119
---
115
120
new_version: username/updated-model
116
121
---
117
122
```
118
123
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.
120
125
121
126
```markdown
122
127
<Gallery>
@@ -125,7 +130,7 @@ Bonus: a recognised library also allows you to track downloads of your model ove
125
130
</Gallery>
126
131
```
127
132
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.
0 commit comments