Hub documentation
Liste de contrôle pour la publication de modèle(s)
Liste de contrôle pour la publication de modèle(s)
Le Hugging Face Hub est la plateforme de référence pour partager des modèles de machine learning. Une publication bien réalisée peut accroître la visibilité et l’impact de votre modèle. Cette section détaille les étapes essentielles pour une publication de modèle concise, informative et conviviale.
Publier avec un agent de codage ? Installez le
hfCLI Skill pour laisser votre agent gérer le téléchargement, la carte du modèle et les métadonnées à votre place.
⏳ Préparation de votre modèle pour sa publication
Télécharger les poids du modèle
Lors de la mise en ligne de modèles sur le Hub, suivez ces bonnes pratiques :
Utiliser des dépôts distincts pour différents poids de modèles : Créez des dépôts individuels pour chaque variante d'une même architecture. Cela vous permet de les regrouper dans une collection, plus facile à parcourir qu'une liste de répertoires. Cela améliore également la visibilité, car chaque modèle possède sa propre URL (
hf.co/org/model-name), facilite la recherche et fournit des compteurs de téléchargements pour chacun de vos modèles. Un excellent exemple est la récente collection Qwen3-VL, qui présente diverses variantes de l'architecture VL.Privilégiez
safetensorsplutôt quepicklepour la sérialisation des poids. :safetensorsest plus sûr et plus rapide quepickleoupthde Python. Si vous disposez d'un fichier pickle.bin, utilisez l'outil de conversion des poids pour le convertir.
Rédiger une fiche de modèle complète
Une fiche de modèle bien conçue (le README.md de votre dépôt) est essentielle pour la découvrabilité, la reproductibilité et le partage efficace. Assurez-vous de couvrir :
Configuration des métadonnées : La section metadata (YAML) en haut de votre carte de modèle est essentielle pour la recherche et la catégorisation. Incluez :
--- pipeline_tag: text-generation # Specify the task library_name: transformers # Specify the library language: - en # List languages your model supports license: apache-2.0 # Specify a license datasets: - username/dataset # List datasets used for training base_model: username/base-model # If applicable (your model is a fine-tune, quantized, merged version of another model) tags: # Add extra tags which would make the repo searchable using the tag - tag1 - tag2 ---Si vous créez le
README.mddans l’interface web, vous verrez un formulaire avec les champs de métadonnées les plus importants que nous recommandons 🤗.
Formulaire de métadonnées dans l’interface utilisateur du Hub Description détaillée du modèle : Fournissez une explication claire de ce que fait votre modèle, de son architecture et de ses cas d’usage prévus. Aidez les utilisateurs à décider rapidement s’il répond à leurs besoins.
Exemples d'utilisation : Fournissez des extraits de code clairs, prêts à être copiés et exécutés, pour l'inférence, le fine-tuning ou d'autres tâches courantes. Limitez au minimum les modifications nécessaires de la part des utilisateurs.
Bonus : ajoutez un
notebook.ipynbbien structuré dans le dépôt, illustrant l’inférence ou l’ajustement fin, afin que les utilisateurs puissent l’ouvrir directement dans Google Colab et Kaggle Notebooks.
Boutons d'utilisation Google et Kaggle Spécifications techniques : Incluez les paramètres d’entraînement, les besoins matériels et autres détails qui aident les utilisateurs à exécuter le modèle de manière efficace.
Métriques de performance : Partagez les résultats des benchmarks et des évaluations. Incluez des métriques quantitatives et des exemples qualitatifs pour illustrer les forces et les limites.
Limitations et biais : Documentez les limitations, les biais et les considérations éthiques connus afin que les utilisateurs puissent faire des choix éclairés.
Pour rendre le processus plus fluide, cliquez sur Import model card template pour préremplir les README.md avec des espaces réservés.
 |  |
|---|---|
| Le bouton pour importer le modèle de carte de modèle | Une section du modèle importé |
Améliorer la découvrabilité et l'utilisabilité des modèles
Pour maximiser la portée et la convivialité :
Intégration de bibliothèques : Ajoutez la prise en charge de l’une des nombreuses bibliothèques intégrées au Hugging Face Hub (telles que
transformers,diffusers,sentence-transformers,timm). Cette intégration augmente considérablement l’accessibilité de votre modèle et fournit aux utilisateurs des extraits de code pour travailler avec votre modèle.Par exemple, pour indiquer que votre modèle fonctionne avec la bibliothèque
transformers:--- library_name: transformers ---
Onglet de fragment de code Vous pouvez également enregistrer votre propre bibliothèque de modèles ou ajouter la prise en charge du Hub à votre bibliothèque et à votre base de code, afin que les utilisateurs sachent comment télécharger les poids des modèles depuis le Hub.
Nous avons rédigé un guide exhaustif sur les bonnes pratiques de téléversement ici.
L'utilisation d'une bibliothèque enregistrée vous permet également de suivre les téléchargements de votre modèle au fil du temps.
Métadonnées correctes :
- Étiquette de pipeline : Choisissez la bonne étiquette de pipeline pour que votre modèle apparaisse dans les bonnes recherches et widgets.
Exemples de balises de pipeline courantes :
text-generation- Pour les modèles de langage qui génèrent du textetext-to-image- Pour les modèles de génération d'images à partir de texteimage-text-to-text- Pour les modèles de vision-langage (VLM) qui génèrent du textetext-to-speech- Pour les modèles qui génèrent de l'audio à partir de texteLicense : Les informations de licence sont cruciales pour que les utilisateurs comprennent comment ils peuvent utiliser le modèle.
Articles de recherche : Si votre modèle est associé à des articles, citez-les dans la carte du modèle. Ils seront croisés automatiquement.
## References * [Model Paper](https://arxiv.org/abs/xxxx.xxxxx)Collections : Si vous publiez plusieurs modèles ou variantes liés, organisez-les dans une collection. Les collections aident les utilisateurs à découvrir des modèles connexes et à comprendre les relations entre les différentes versions.
Démonstrations : Créez un Hugging Face Space avec une démonstration interactive. Cela permet aux utilisateurs d’essayer votre modèle sans écrire de code. Vous pouvez également lier le modèle depuis le Space pour qu’il apparaisse dans l’interface de la page du modèle.
## Demo Try this model directly in your browser: [Space Demo](https://huggingface.co/spaces/username/model-demo)Lors de la création d'une démo, téléchargez le modèle depuis son dépôt Hub (et non depuis des sources externes comme Google Drive). Cela crée des liens croisés entre les artefacts et améliore la visibilité
Version quantifiées : Envisagez de téléverser des versions quantifiées (par exemple, GGUF) dans un dépôt distinct afin d’améliorer l’accessibilité pour les utilisateurs disposant de ressources de calcul limitées. Liez ces versions à l’aide du champ de métadonnées
base_modelsur les fiches des modèles quantifiés, et documentez les différences de performances.--- base_model: username/original-model base_model_relation: quantized ---
Arbre des modèles montrant les versions quantifiées Lier des jeux de données à la page du modèle : Liez les jeux de données dans vos métadonnées afin qu’ils apparaissent directement sur la page de votre modèle.
--- datasets: - username/dataset - username/dataset-2 ---Nouvelle version de modèle : Si votre modèle est une mise à jour d’un modèle existant, indiquez-le sur la carte du modèle antérieur. Cela affichera un bandeau sur l’ancienne page, avec un lien vers la mise à jour.
--- new_version: username/updated-model ---Exemples visuels : Pour les modèles de génération d’images ou de vidéos, incluez des exemples directement sur votre page de modèle à l’aide du composant de carte
<Gallery>.<Gallery>   </Gallery>Émissions de carbone : Si possible, spécifiez les émissions de carbone issues de l’entraînement.
--- co2_eq_emissions: emissions: 123.45 source: "CodeCarbon" training_type: "pre-training" geographical_location: "US-East" hardware_used: "8xA100 GPUs" ---
Contrôle d'accès et visibilité
Paramètres de visibilité : Lorsque vous êtes prêt à partager votre modèle, passez-le en public dans vos paramètres de modèle. Avant de le faire, vérifiez à nouveau que toute la documentation et les exemples de code sont exacts et complets.
Accès contrôlé : Si votre modèle nécessite un accès contrôlé, utilisez la fonctionnalité d'accès contrôlé et énoncez clairement les conditions que les utilisateurs doivent remplir. C'est important pour les modèles soulevant des préoccupations d'usage dual ou soumis à des restrictions commerciales.
🏁 Après la publication de votre modèle
Une publication de modèle réussie ne s'arrête pas à la mise en ligne initiale. Pour maintenir la qualité et maximiser l'impact :
Maintenance et engagement de la communauté
Vérifier le fonctionnement : Après la publication, testez tous les extraits de code dans un environnement propre pour vous assurer qu'ils fonctionnent comme prévu. Cela garantit que les utilisateurs peuvent exécuter votre modèle sans erreur ni confusion.
Par exemple, si votre modèle est un LLM compatible
transformers:from transformers import pipeline # This should run without errors pipe = pipeline("text-generation", model="your-username/your-model") result = pipe("Your test prompt") print(result)Partager Partager Partager : La plupart des utilisateurs découvrent les modèles via les réseaux sociaux, les canaux de discussion (comme Slack ou Discord) ou les newsletters. Partagez les liens de vos modèles dans ces espaces, et ajoutez-les également à votre site web ou à vos dépôts GitHub.
Plus votre modèle reçoit de visites et de likes, plus il apparaît haut dans la section Hugging Face Trending, ce qui lui apporte encore plus de visibilité
Interaction avec la communauté : Utilisez l'onglet Communauté pour répondre aux questions, traiter les retours et résoudre les problèmes rapidement. Clarifiez les points de confusion, acceptez les suggestions utiles et fermez les fils hors sujet pour garder les discussions ciblées.
Ajouter les résultats d'évaluation
Si vous évaluez sur l’un des jeux de données de référence pris en charge sur le Hub, vous pouvez ajouter les résultats d’évaluation à votre dépôt de modèle. Cela rendra les scores de référence visibles directement sur la page du modèle et sur le classement des références du dépôt de jeu de données. Consultez la documentation des résultats d’évaluation pour la spécification complète.
Pour ajouter des résultats d’évaluation, créez des fichiers YAML dans le dossier .eval_results/ de votre dépôt de modèle. Chaque fichier référence un jeu de données Hub Benchmark :
# .eval_results/gpqa.yaml
- dataset:
id: Idavidrein/gpqa
task_id: diamond
value: 76.1
date: "2026-03-19"
source:
url: https://huggingface.co/your-org/your-model
name: Model Card
user: your-usernameLe task_id doit correspondre à une tâche définie dans le fichier eval.yaml du jeu de données de référence. Vous pouvez consulter les fichiers eval.yaml des dépôts de jeux de données de référence, comme HLE, pour trouver les références disponibles et leurs identifiants de tâche.
Tout membre de la communauté peut également soumettre des résultats d’évaluation pour n’importe quel modèle en ouvrant une Pull Request. Les scores soumis par la communauté affichent un badge « community » sur la page du modèle. Pour simplifier ce processus, vous pouvez utiliser le dépôt community-evals, qui fournit des scripts et une compétence d’agent pour extraire les scores des fiches de modèle et créer des PR automatiquement.
Suivi de l'utilisation et de l'impact
Métriques d’utilisation : Suivez les téléchargements et les likes pour comprendre la portée et l’adoption de votre modèle. Vous pouvez consulter les métriques de téléchargement totales dans les paramètres de votre modèle.
Examiner les contributions de la communauté : Vérifiez régulièrement le dépôt de votre modèle pour prendre connaissance des contributions d’autres utilisateurs. Les demandes de fusion et les discussions de la communauté peuvent fournir des retours, des idées et des opportunités de collaboration utiles.
🏢 Fonctionnalités d'entreprise
L’abonnement Hugging Face Team & Enterprise offre des fonctionnalités supplémentaires aux équipes et aux organisations :
Contrôle d'accès : Définissez des groupes de ressources pour gérer l'accès de équipes ou d'utilisateurs spécifiques. Cela garantit les permissions appropriées et une collaboration sécurisée au sein de votre organisation.
Région de stockage : Choisissez la région de stockage des données (États-Unis ou Europe) pour vos fichiers de modèle afin de respecter les réglementations et les exigences de conformité régionales en matière de données.
Analytique avancée : Utilisez Publisher Analytics pour obtenir des informations plus approfondies sur les modèles d’utilisation, les téléchargements et les tendances d’adoption au sein de votre organisation.
Stockage étendu : Accédez à une capacité de stockage privée supplémentaire pour héberger davantage de modèles et des artefacts plus volumineux au fur et à mesure que votre portefeuille de modèles s’agrandit.
Articles de blog des organisations : Les organisations d’entreprise peuvent désormais publier des articles de blog directement sur Hugging Face. Cela vous permet de partager des sorties de modèles, des mises à jour de recherche et des annonces avec la communauté, le tout depuis le profil de votre organisation.
En suivant ces directives et exemples, vous rendrez la publication de votre modèle sur Hugging Face claire, utile et percutante. Cela permet à votre travail de toucher un public plus large, renforce la communauté de l’IA et augmente la visibilité de votre modèle.
Nous avons hâte de voir ce que vous partagerez ensuite ! 🤗
Update on GitHub