Datasets documentation

Create a dataset card

You are viewing v2.4.0 version. A newer version v2.19.0 is available.
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Create a dataset card

Each dataset should have a dataset card to promote responsible usage and inform users of any potential biases within the dataset. This idea was inspired by the Model Cards proposed by Mitchell, 2018. Dataset cards help users understand a dataset’s contents, the context for using the dataset, how it was created, and any other considerations a user should be aware of.

This guide shows you how to create a dataset card.

  1. Create a new dataset card by copying this template to a file in your repository.

  2. Generate structured tags to help users discover your dataset on the Hub. Create the tags with the online Datasets Tagging app.

  3. Select the appropriate tags for your dataset from the dropdown menus.

  4. Copy the YAML tags under Finalized tag set and paste the tags at the top of your file.

  5. Fill out the dataset card sections to the best of your ability. Take a look at the Dataset Card Creation Guide for more detailed information about what to include in each section of the card. For fields you are unable to complete, you can write [More Information Needed].

  6. Once you’re done filling out the dataset card, commit the changes to the file and you should see the completed dataset card on your repository.

Feel free to take a look at these dataset card examples to help you get started: