Datasets documentation

Créer une carte de jeu de données

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Créer une carte de jeu de données

Chaque jeu de données doit être accompagné d’une carte de jeu de données (dataset card) afin de promouvoir un usage responsable et d’informer les utilisateurs des éventuels biais présents dans le jeu de données. Cette idée s’inspire des Model Cards proposés par Mitchell, 2018. Les cartes de jeu de données aident les utilisateurs à comprendre le contenu d’un jeu de données, le contexte de son utilisation, la manière dont il a été créé, ainsi que toute autre considération à laquelle l’utilisateur doit prêter attention.

Créer une carte de jeu de données est simple et ne demande que quelques étapes :

  1. Accédez à votre dépôt de jeu de données sur le Hub et cliquez sur Create Dataset Card pour créer un nouveau fichier README.md dans votre dépôt.

  2. Utilisez l'interface de métadonnées pour sélectionner les étiquettes qui décrivent votre jeu de données. Vous pouvez ajouter une licence, une langue, un pretty_name, des task_categories, des size_categories et toute autre étiquette que vous jugez pertinente. Ces étiquettes aident les utilisateurs à découvrir et à trouver votre jeu de données sur le Hub.

Pour un ensemble complet, mais non obligatoire, d’options de balises, vous pouvez également consulter les spécifications des cartes de jeu de données. Vous y trouverez quelques options de balises supplémentaires comme multilinguality et language_creators, utiles mais pas absolument nécessaires.

  1. Cliquez sur le lien Import dataset card template pour créer automatiquement un modèle contenant tous les champs pertinents à compléter. Remplissez les sections du modèle au mieux de vos capacités. Consultez le Dataset Card Creation Guide pour obtenir des informations plus détaillées sur le contenu à inclure dans chaque section de la carte. Pour les champs que vous ne pouvez pas compléter, vous pouvez écrire [More Information Needed].

  2. Une fois terminé, committez les modifications dans le fichier README.md et vous verrez la carte de jeu de données complétée sur votre dépôt.

YAML vous permet également de personnaliser la manière dont votre jeu de données est chargé en définissant des splits et/ou des configurations sans avoir à écrire de code.

N'hésitez pas à consulter les fiches des jeux de données SNLI, CNN/DailyMail et Allociné comme exemples pour vous aider à démarrer.

Update on GitHub