datasets/v2.1.0/en/dataset_card.html

<meta charset="utf-8" /><meta http-equiv="content-security-policy" content=""><meta name="hf:doc:metadata" content="{&quot;local&quot;:&quot;create-a-dataset-card&quot;,&quot;title&quot;:&quot;Create a dataset card&quot;}" data-svelte="svelte-1phssyn">
	<link rel="modulepreload" href="/docs/datasets/v2.1.0/en/_app/assets/pages/__layout.svelte-efc77dbd.css">
	<link rel="modulepreload" href="/docs/datasets/v2.1.0/en/_app/start-de3d4f61.js">
	<link rel="modulepreload" href="/docs/datasets/v2.1.0/en/_app/chunks/vendor-8138ceec.js">
	<link rel="modulepreload" href="/docs/datasets/v2.1.0/en/_app/chunks/paths-4b3c6e7e.js">
	<link rel="modulepreload" href="/docs/datasets/v2.1.0/en/_app/pages/__layout.svelte-efb8e839.js">
	<link rel="modulepreload" href="/docs/datasets/v2.1.0/en/_app/pages/dataset_card.mdx-280e0a86.js">
	<link rel="modulepreload" href="/docs/datasets/v2.1.0/en/_app/chunks/IconCopyLink-2dd3a6ac.js"> 





<h1 class="relative group"><a id="create-a-dataset-card" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#create-a-dataset-card"><span><svg class="" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg></span></a>
	<span>Create a dataset card
	</span></h1>

<p>Each dataset should be accompanied with a Dataset card to promote responsible usage, and alert the user to any potential biases within the dataset.
This idea is inspired by the Model Cards proposed by <a href="https://arxiv.org/abs/1810.03993" rel="nofollow">Mitchell, 2018</a>.
Dataset cards help users understand the contents of the dataset, context for how the dataset should be used, how it was created, and considerations for using the dataset.
This guide shows you how to create your own Dataset card.</p>
<ol><li><p>Create a new Dataset card by opening the <a href="https://huggingface.co/datasets/card-creator/" rel="nofollow">online card creator</a>, or manually copying the template from <a href="https://raw.githubusercontent.com/huggingface/datasets/master/templates/README.md" rel="nofollow">here</a>.</p></li>
<li><p>Next, you need to generate structured tags. The tags help users discover your dataset on the Hub. Create the tags with the <a href="https://huggingface.co/spaces/huggingface/datasets-tagging" rel="nofollow">online Datasets Tagging app</a>.</p></li>
<li><p>Select the appropriate tags for your dataset from the dropdown menus, and save the file once you are done.</p></li>
<li><p>Expand the <strong>Show YAML output aggregating the tags</strong> section on the right, copy the YAML tags, and paste it under the matching section on the online form. Paste the tags into your <code>README.md</code> file if you manually created your Dataset card.</p></li>
<li><p>Expand the <strong>Show Markdown Data Fields</strong> section, paste it into the <strong>Data Fields</strong> section under <strong>Data Structure</strong> on the online form (or your local <code>README.md</code>). Modify the descriptions as needed, and briefly describe each of the fields.</p></li>
<li><p>Fill out the Dataset card to the best of your ability. Refer to the <a href="https://github.com/huggingface/datasets/blob/master/templates/README_guide.md" rel="nofollow">Dataset Card Creation Guide</a> for more detailed information about each section of the card. For fields you are unable to complete, you can write <strong>[More Information Needed]</strong>.</p></li>
<li><p>Once you are done filling out the card with the online form, click the <strong>Export</strong> button to download the Dataset card. Place it in the same folder as your dataset.</p></li></ol>
<p>Feel free to take a look at these examples of good Dataset cards for inspiration:</p>
<ul><li><a href="https://huggingface.co/datasets/snli" rel="nofollow">SNLI</a></li>
<li><a href="https://huggingface.co/datasets/cnn_dailymail" rel="nofollow">CNN / DailyMail</a></li>
<li><a href="https://huggingface.co/datasets/allocine" rel="nofollow">Allociné</a></li></ul>


		<script type="module" data-hydrate="16nlszd">
		import { start } from "/docs/datasets/v2.1.0/en/_app/start-de3d4f61.js";
		start({
			target: document.querySelector('[data-hydrate="16nlszd"]').parentNode,
			paths: {"base":"/docs/datasets/v2.1.0/en","assets":"/docs/datasets/v2.1.0/en"},
			session: {},
			route: false,
			spa: false,
			trailing_slash: "never",
			hydrate: {
				status: 200,
				error: null,
				nodes: [
					import("/docs/datasets/v2.1.0/en/_app/pages/__layout.svelte-efb8e839.js"),
						import("/docs/datasets/v2.1.0/en/_app/pages/dataset_card.mdx-280e0a86.js")
				],
				params: {}
			}
		});
	</script>