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
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -74,17 +74,17 @@ Bonus: a recognised library also allows you to track downloads of your model ove
74
74
75
75
-**License:** Properly filling the license information in metadata will help users see if they can use the model for commercial or research purposes.
76
76
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.
77
+
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.
78
78
79
79
```markdown
80
80
## References
81
81
82
82
* [Model Paper](https://arxiv.org/abs/xxxx.xxxxx)
83
83
```
84
84
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.
85
+
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.
86
86
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.
87
+
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.
88
88
89
89
```markdown
90
90
## Demo
@@ -94,7 +94,7 @@ Bonus: a recognised library also allows you to track downloads of your model ove
94
94
95
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.
96
96
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.
97
+
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.
98
98
99
99
```yaml
100
100
---
@@ -103,7 +103,7 @@ It's a good practise to load the model from the model's own repository in the de
103
103
---
104
104
```
105
105
106
-
8.**Linking Datasets on the Model Page**: Link datasets in your `README.md` metadata to display those used directly from your model page.
106
+
9.**Linking Datasets on the Model Page**: Link datasets in your `README.md` metadata to display those used directly from your model page.
107
107
108
108
```yaml
109
109
---
@@ -113,15 +113,15 @@ It's a good practise to load the model from the model's own repository in the de
113
113
---
114
114
```
115
115
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.
116
+
10.**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.
117
117
118
118
```yaml
119
119
---
120
120
new_version: username/updated-model
121
121
---
122
122
```
123
123
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.
124
+
11.**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.
125
125
126
126
```markdown
127
127
<Gallery>
@@ -130,7 +130,7 @@ It's a good practise to load the model from the model's own repository in the de
130
130
</Gallery>
131
131
```
132
132
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.
133
+
12.**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