Skip to content

Commit eb31aa1

Browse files
authored
Update model-release-checklist.md
1 parent 43c074c commit eb31aa1

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

docs/hub/model-release-checklist.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -74,17 +74,17 @@ Bonus: a recognised library also allows you to track downloads of your model ove
7474

7575
- **License:** Properly filling the license information in metadata will help users see if they can use the model for commercial or research purposes.
7676

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.
7878

7979
```markdown
8080
## References
8181

8282
* [Model Paper](https://arxiv.org/abs/xxxx.xxxxx)
8383
```
8484

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.
8686

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.
8888

8989
```markdown
9090
## Demo
@@ -94,7 +94,7 @@ Bonus: a recognised library also allows you to track downloads of your model ove
9494

9595
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.
9696

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.
9898

9999
```yaml
100100
---
@@ -103,7 +103,7 @@ It's a good practise to load the model from the model's own repository in the de
103103
---
104104
```
105105

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.
107107

108108
```yaml
109109
---
@@ -113,15 +113,15 @@ It's a good practise to load the model from the model's own repository in the de
113113
---
114114
```
115115

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.
117117

118118
```yaml
119119
---
120120
new_version: username/updated-model
121121
---
122122
```
123123

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.
125125

126126
```markdown
127127
<Gallery>
@@ -130,7 +130,7 @@ It's a good practise to load the model from the model's own repository in the de
130130
</Gallery>
131131
```
132132

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.
134134

135135
```yaml
136136
---

0 commit comments

Comments
 (0)