Skip to content
Merged
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/hub/model-release-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,16 @@ We wrote an extensive guide on uploading best practices [here](https://huggingfa

Bonus: a recognised library also allows you to track downloads of your model over time.

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.
2. **Correct Metadata**:
- **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.

Examples of common pipeline tags:
- `text-generation` - For language models that generate text
- `text-to-image` - For text-to-image generation models
- `image-text-to-text` - For vision-language models (VLMs) that generate text
- `text-to-speech` - For models that generate audio from text

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

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.

Expand All @@ -88,6 +91,8 @@ Bonus: a recognised library also allows you to track downloads of your model ove

Try this model directly in your browser: [Space Demo](https://huggingface.co/spaces/username/model-demo)
```

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.

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.

Expand Down