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
+6-6Lines changed: 6 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# Checklist for an impactful model release
1
+
# Model(s) Release Checklist
2
2
3
3
The Hugging Face Hub is the go-to platform for sharing machine learning models. A well-executed release can boost your model's visibility and impact. This section covers essential steps for a concise, informative, and user-friendly model release.
4
4
@@ -54,7 +54,7 @@ To maximize your model's reach and usability:
54
54
-`image-text-to-text` - For vision language models that generate text
55
55
-`text-to-speech` - For models that generate audio from text
56
56
57
-
3.**Research Papers**: If your model originates from research papers, you can cite them in your model card and it will [link them automatically](https://huggingface.co/docs/hub/model-cards#linking-a-paper) in your model card. This provides academic context and allows users to dive deeper into the theoretical foundations of your work.
57
+
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 and allows users to dive deeper into the theoretical foundations of your work.
58
58
59
59
```markdown
60
60
## References
@@ -64,7 +64,7 @@ To maximize your model's reach and usability:
64
64
65
65
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.
66
66
67
-
5.**Demo**: 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.
67
+
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.
68
68
69
69
```markdown
70
70
## Demo
@@ -80,7 +80,7 @@ To maximize your model's reach and usability:
80
80
---
81
81
```
82
82
83
-
7.**Linking Datasets on the Model Page**: Link datasets in your ```README.md``` metadata to display those used directly on your model page.
83
+
7.**Linking Datasets on the Model Page**: Link datasets in your ```README.md``` metadata to display those used directly from your model page.
84
84
85
85
```yaml
86
86
---
@@ -90,15 +90,15 @@ To maximize your model's reach and usability:
90
90
---
91
91
```
92
92
93
-
8.**New Model Version**: If this model is an update of an existing one, you can specify it on the previous version model metadata. This will display a banner on the older model's page linking directly to this updated version.
93
+
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.
94
94
95
95
```yaml
96
96
---
97
97
new_version: username/updated-model
98
98
---
99
99
```
100
100
101
-
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/model-card-components). Visual examples provide immediate insight into your model's capabilities.
101
+
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.
0 commit comments