Skip to content

Commit 3da9053

Browse files
committed
Update model-release-checklist.md
1 parent cdb11a1 commit 3da9053

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/hub/model-release-checklist.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Checklist for an impactful model release
1+
# Model(s) Release Checklist
22

33
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.
44

@@ -54,7 +54,7 @@ To maximize your model's reach and usability:
5454
- `image-text-to-text` - For vision language models that generate text
5555
- `text-to-speech` - For models that generate audio from text
5656

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

5959
```markdown
6060
## References
@@ -64,7 +64,7 @@ To maximize your model's reach and usability:
6464

6565
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.
6666

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

6969
```markdown
7070
## Demo
@@ -80,7 +80,7 @@ To maximize your model's reach and usability:
8080
---
8181
```
8282

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

8585
```yaml
8686
---
@@ -90,15 +90,15 @@ To maximize your model's reach and usability:
9090
---
9191
```
9292

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

9595
```yaml
9696
---
9797
new_version: username/updated-model
9898
---
9999
```
100100

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

103103
```markdown
104104
<Gallery>

0 commit comments

Comments
 (0)