datasets/main/en/dataset_card.html

<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;Create a dataset card&quot;,&quot;local&quot;:&quot;create-a-dataset-card&quot;,&quot;sections&quot;:[],&quot;depth&quot;:1}">
		<link href="/docs/datasets/main/en/_app/immutable/assets/0.e3b0c442.css" rel="modulepreload">
		<link rel="modulepreload" href="/docs/datasets/main/en/_app/immutable/entry/start.4d44eea4.js">
		<link rel="modulepreload" href="/docs/datasets/main/en/_app/immutable/chunks/scheduler.bdbef820.js">
		<link rel="modulepreload" href="/docs/datasets/main/en/_app/immutable/chunks/singletons.36b689ad.js">
		<link rel="modulepreload" href="/docs/datasets/main/en/_app/immutable/chunks/index.8a885b74.js">
		<link rel="modulepreload" href="/docs/datasets/main/en/_app/immutable/chunks/paths.27092e28.js">
		<link rel="modulepreload" href="/docs/datasets/main/en/_app/immutable/entry/app.d83067e8.js">
		<link rel="modulepreload" href="/docs/datasets/main/en/_app/immutable/chunks/index.c0aea24a.js">
		<link rel="modulepreload" href="/docs/datasets/main/en/_app/immutable/nodes/0.bfb01985.js">
		<link rel="modulepreload" href="/docs/datasets/main/en/_app/immutable/chunks/each.e59479a4.js">
		<link rel="modulepreload" href="/docs/datasets/main/en/_app/immutable/nodes/15.a06fe0ae.js">
		<link rel="modulepreload" href="/docs/datasets/main/en/_app/immutable/chunks/Tip.31005f7d.js">
		<link rel="modulepreload" href="/docs/datasets/main/en/_app/immutable/chunks/EditOnGithub.725ee0c1.js"><!-- HEAD_svelte-u9bgzb_START --><meta name="hf:doc:metadata" content="{&quot;title&quot;:&quot;Create a dataset card&quot;,&quot;local&quot;:&quot;create-a-dataset-card&quot;,&quot;sections&quot;:[],&quot;depth&quot;:1}"><!-- HEAD_svelte-u9bgzb_END -->      <p></p>  <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 data-svelte-h="svelte-1t3wyw1">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 <a href="https://arxiv.org/abs/1810.03993" rel="nofollow">Mitchell, 2018</a>.
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.</p> <p data-svelte-h="svelte-1ia96fv">Creating a dataset card is easy and can be done in just a few steps:</p> <ol data-svelte-h="svelte-9w9t8g"><li><p>Go to your dataset repository on the <a href="https://hf.co/new-dataset" rel="nofollow">Hub</a> and click on <strong>Create Dataset Card</strong> to create a new <code>README.md</code> file in your repository.</p></li> <li><p>Use the <strong>Metadata UI</strong> to select the tags that describe your dataset. You can add a license, language, pretty_name, the task_categories, size_categories, and any other tags that you think are relevant. These tags help users discover and find your dataset on the Hub.</p></li></ol> <div class="flex justify-center" data-svelte-h="svelte-78myk1"><img class="block dark:hidden" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/datasets-metadata-ui.png"> <img class="hidden dark:block" src="https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/hub/datasets-metadata-ui-dark.png"></div>  <div class="course-tip  bg-gradient-to-br dark:bg-gradient-to-r before:border-green-500 dark:before:border-green-800 from-green-50 dark:from-gray-900 to-white dark:to-gray-950 border border-green-50 text-green-700 dark:text-gray-400"><p data-svelte-h="svelte-edd086">For a complete, but not required, set of tag options you can also look at the <a href="https://github.com/huggingface/hub-docs/blob/main/datasetcard.md?plain=1" rel="nofollow">Dataset Card specifications</a>. This’ll have a few more tag options like <code>multilinguality</code> and <code>language_creators</code> which are useful but not absolutely necessary.</p></div> <ol start="3" data-svelte-h="svelte-tamvby"><li><p>Click on the <strong>Import dataset card template</strong> link to automatically create a template with all the relevant fields to complete. Fill out the template sections to the best of your ability. Take a look at the <a href="https://github.com/huggingface/datasets/blob/main/templates/README_guide.md" rel="nofollow">Dataset Card Creation Guide</a> for more detailed information about what to include in 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’re done, commit the changes to the <code>README.md</code> file and you’ll see the completed dataset card on your repository.</p></li></ol> <p data-svelte-h="svelte-ttvehl">YAML also allows you to customize the way your dataset is loaded by <a href="./repository_structure#define-your-splits-and-subsets-in-yaml">defining splits and/or configurations</a> without the need to write any code.</p> <p data-svelte-h="svelte-bje2ue">Feel free to take a look at the <a href="https://huggingface.co/datasets/snli" rel="nofollow">SNLI</a>, <a href="https://huggingface.co/datasets/cnn_dailymail" rel="nofollow">CNN/DailyMail</a>, and <a href="https://huggingface.co/datasets/allocine" rel="nofollow">Allociné</a> dataset cards as examples to help you get started.</p> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/huggingface/datasets/blob/main/docs/source/dataset_card.mdx" target="_blank"><span data-svelte-h="svelte-1kd6by1">&lt;</span> <span data-svelte-h="svelte-x0xyl0">&gt;</span> <span data-svelte-h="svelte-1dajgef"><span class="underline ml-1.5">Update</span> on GitHub</span></a>  <p></p> 
			
			<script>
				{
					__sveltekit_w3org2 = {
						assets: "/docs/datasets/main/en",
						base: "/docs/datasets/main/en",
						env: {}
					};

					const element = document.currentScript.parentElement;

					const data = [null,null];

					Promise.all([
						import("/docs/datasets/main/en/_app/immutable/entry/start.4d44eea4.js"),
						import("/docs/datasets/main/en/_app/immutable/entry/app.d83067e8.js")
					]).then(([kit, app]) => {
						kit.start(app, element, {
							node_ids: [0, 15],
							data,
							form: null,
							error: null
						});
					});
				}
			</script>