Conversation
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
docs/hub/model-release-checklist.md
Outdated
|
|
||
| ### Uploading Weights | ||
| - **Use separate repositories for different model weights**: | ||
| Create individual repositories for each variant of the same architecture. This lets you group them into a [collection](https://huggingface.co/docs/hub/en/collections), which users prefer when browsing many options. It also improves visibility because each model has its own URL (`hf.co/org/model-name`) and is easier to search. |
There was a problem hiding this comment.
| Create individual repositories for each variant of the same architecture. This lets you group them into a [collection](https://huggingface.co/docs/hub/en/collections), which users prefer when browsing many options. It also improves visibility because each model has its own URL (`hf.co/org/model-name`) and is easier to search. | |
| Create individual repositories for each variant of the same architecture. This lets you group them into a [collection](https://huggingface.co/docs/hub/en/collections), which are easier to navigate than directory listings. It also improves visibility because each model has its own URL (`hf.co/org/model-name`), makes search easier, and provides download counts for each one of your models. |
There was a problem hiding this comment.
not sure if needed but we could also mention that it makes it easier to integrate with downstream libraries too.
There was a problem hiding this comment.
@Vaibhavs10 how do you mean? I thought downstream libraries only benefit from transformers integration. If you could guide me into understanding this point better I will add it here.
Vaibhavs10
left a comment
There was a problem hiding this comment.
very cool! thanks for the update, agree with most of the comments Pedro made and left a few suggestions.
docs/hub/model-release-checklist.md
Outdated
|
|
||
| ### Uploading Weights | ||
| - **Use separate repositories for different model weights**: | ||
| Create individual repositories for each variant of the same architecture. This lets you group them into a [collection](https://huggingface.co/docs/hub/en/collections), which users prefer when browsing many options. It also improves visibility because each model has its own URL (`hf.co/org/model-name`) and is easier to search. |
There was a problem hiding this comment.
not sure if needed but we could also mention that it makes it easier to integrate with downstream libraries too.
docs/hub/model-release-checklist.md
Outdated
|
|
||
| Bonus: a recognised library also allows you to track downloads of your model over time. | ||
| > [!NOTE] | ||
| > A recognised library also allows you to track downloads of your model over time. |
There was a problem hiding this comment.
maybe we could link this in the registered library bit: https://huggingface.co/docs/hub/en/models-adding-libraries
| To make the process more seamless, click **Import model card template** to pre-fill the `README.md`s with placeholders. | ||
|
|
||
| 1. **Library Integration**: If possible, add support for one of the many [libraries integrated with the Hugging Face Hub](https://huggingface.co/docs/hub/models-libraries) (such as Transformers or Diffusers). This integration significantly increases your model's accessibility and provides users with code snippets for working with your model. | ||
| |  |  | |
There was a problem hiding this comment.
Not sure how this will render in a table, given that the left button is very wide. I tried to check here, but images are not shown for some reason:
To note: I have added an
assetsfolder, which will be deleted later, once I have a green signal on the assets. I will add the assets to the hub, and link the URL.The PR is made to refactor the current model checklist, with an idea of being more concise and actionable insights. I felt the doc also did not have example images, so have added them.
I am open to feedback as this has not been reviewed by and HF team member in the past, so I am open to closing it as well if there is no need of this at the current moment. 🤗