import{s as X,o as Z,n as tt}from"../chunks/scheduler.bdbef820.js";import{S as et,i as at,g as r,s as n,r as N,A as st,h as d,f as a,c as i,j as W,u as O,x as h,k as F,y as ot,a as s,v as R,d as S,t as z,w as G}from"../chunks/index.c0aea24a.js";import{T as nt}from"../chunks/Tip.31005f7d.js";import{H as it,E as lt}from"../chunks/EditOnGithub.725ee0c1.js";function rt(C){let o,f='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.';return{c(){o=r("p"),o.innerHTML=f},l(l){o=d(l,"P",{"data-svelte-h":!0}),h(o)!=="svelte-edd086"&&(o.innerHTML=f)},m(l,$){s(l,o,$)},p:tt,d(l){l&&a(o)}}}function dt(C){let o,f,l,$,m,T,g,U=`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.`,x,y,q="Creating a dataset card is easy and can be done in just a few steps:",L,b,Y='<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>',k,c,V='<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"/>',H,u,E,p,B='<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>',P,w,J='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.',D,_,K='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.',A,v,I,M,j;return m=new it({props:{title:"Create a dataset card",local:"create-a-dataset-card",headingTag:"h1"}}),u=new nt({props:{$$slots:{default:[rt]},$$scope:{ctx:C}}}),v=new lt({props:{source:"https://github.com/huggingface/datasets/blob/main/docs/source/dataset_card.mdx"}}),{c(){o=r("meta"),f=n(),l=r("p"),$=n(),N(m.$$.fragment),T=n(),g=r("p"),g.innerHTML=U,x=n(),y=r("p"),y.textContent=q,L=n(),b=r("ol"),b.innerHTML=Y,k=n(),c=r("div"),c.innerHTML=V,H=n(),N(u.$$.fragment),E=n(),p=r("ol"),p.innerHTML=B,P=n(),w=r("p"),w.innerHTML=J,D=n(),_=r("p"),_.innerHTML=K,A=n(),N(v.$$.fragment),I=n(),M=r("p"),this.h()},l(t){const e=st("svelte-u9bgzb",document.head);o=d(e,"META",{name:!0,content:!0}),e.forEach(a),f=i(t),l=d(t,"P",{}),W(l).forEach(a),$=i(t),O(m.$$.fragment,t),T=i(t),g=d(t,"P",{"data-svelte-h":!0}),h(g)!=="svelte-1t3wyw1"&&(g.innerHTML=U),x=i(t),y=d(t,"P",{"data-svelte-h":!0}),h(y)!=="svelte-1ia96fv"&&(y.textContent=q),L=i(t),b=d(t,"OL",{"data-svelte-h":!0}),h(b)!=="svelte-9w9t8g"&&(b.innerHTML=Y),k=i(t),c=d(t,"DIV",{class:!0,"data-svelte-h":!0}),h(c)!=="svelte-78myk1"&&(c.innerHTML=V),H=i(t),O(u.$$.fragment,t),E=i(t),p=d(t,"OL",{start:!0,"data-svelte-h":!0}),h(p)!=="svelte-tamvby"&&(p.innerHTML=B),P=i(t),w=d(t,"P",{"data-svelte-h":!0}),h(w)!=="svelte-ttvehl"&&(w.innerHTML=J),D=i(t),_=d(t,"P",{"data-svelte-h":!0}),h(_)!=="svelte-bje2ue"&&(_.innerHTML=K),A=i(t),O(v.$$.fragment,t),I=i(t),M=d(t,"P",{}),W(M).forEach(a),this.h()},h(){F(o,"name","hf:doc:metadata"),F(o,"content",ct),F(c,"class","flex justify-center"),F(p,"start","3")},m(t,e){ot(document.head,o),s(t,f,e),s(t,l,e),s(t,$,e),R(m,t,e),s(t,T,e),s(t,g,e),s(t,x,e),s(t,y,e),s(t,L,e),s(t,b,e),s(t,k,e),s(t,c,e),s(t,H,e),R(u,t,e),s(t,E,e),s(t,p,e),s(t,P,e),s(t,w,e),s(t,D,e),s(t,_,e),s(t,A,e),R(v,t,e),s(t,I,e),s(t,M,e),j=!0},p(t,[e]){const Q={};e&2&&(Q.$$scope={dirty:e,ctx:t}),u.$set(Q)},i(t){j||(S(m.$$.fragment,t),S(u.$$.fragment,t),S(v.$$.fragment,t),j=!0)},o(t){z(m.$$.fragment,t),z(u.$$.fragment,t),z(v.$$.fragment,t),j=!1},d(t){t&&(a(f),a(l),a($),a(T),a(g),a(x),a(y),a(L),a(b),a(k),a(c),a(H),a(E),a(p),a(P),a(w),a(D),a(_),a(A),a(I),a(M)),a(o),G(m,t),G(u,t),G(v,t)}}}const ct='{"title":"Create a dataset card","local":"create-a-dataset-card","sections":[],"depth":1}';function ut(C){return Z(()=>{new URLSearchParams(window.location.search).get("fw")}),[]}class gt extends et{constructor(o){super(),at(this,o,ut,dt,X,{})}}export{gt as component};
