import{S as pt,i as mt,s as yt,e as s,k as w,w as it,t as o,M as gt,c as l,d as t,m as b,a as n,x as dt,h as r,b as d,G as e,g as E,y as ct,q as ht,o as ut,B as ft,v as _t}from"../chunks/vendor-hf-doc-builder.js";import{T as vt}from"../chunks/Tip-hf-doc-builder.js";import{I as Et}from"../chunks/IconCopyLink-hf-doc-builder.js";function wt(oe){let i,A,h,p,k,f,O,C,$,M,m;return{c(){i=s("p"),A=o("For a complete, but not required, set of tag options you can also look at the "),h=s("a"),p=o("Dataset Card specifications"),k=o(". This\u2019ll have a few more tag options like "),f=s("code"),O=o("multilinguality"),C=o(" and "),$=s("code"),M=o("language_creators"),m=o(" which are useful but not absolutely necessary."),this.h()},l(D){i=l(D,"P",{});var c=n(i);A=r(c,"For a complete, but not required, set of tag options you can also look at the "),h=l(c,"A",{href:!0,rel:!0});var Y=n(h);p=r(Y,"Dataset Card specifications"),Y.forEach(t),k=r(c,". This\u2019ll have a few more tag options like "),f=l(c,"CODE",{});var B=n(f);O=r(B,"multilinguality"),B.forEach(t),C=r(c," and "),$=l(c,"CODE",{});var S=n($);M=r(S,"language_creators"),S.forEach(t),m=r(c," which are useful but not absolutely necessary."),c.forEach(t),this.h()},h(){d(h,"href","https://github.com/huggingface/hub-docs/blob/main/datasetcard.md?plain=1"),d(h,"rel","nofollow")},m(D,c){E(D,i,c),e(i,A),e(i,h),e(h,p),e(i,k),e(i,f),e(f,O),e(i,C),e(i,$),e($,M),e(i,m)},d(D){D&&t(i)}}}function bt(oe){let i,A,h,p,k,f,O,C,$,M,m,D,c,Y,B,S,J,he,re,y,K,_,ue,R,fe,pe,Q,me,ye,V,ge,_e,ve,G,L,Ee,W,we,be,ke,N,Ce,X,v,$e,Z,De,Ae,F,Me,Ne,ee,Te,Ie,Pe,te,q,xe,ae,Oe,Se,se,g,Re,H,Ge,Le,U,Fe,qe,j,He,Ue,le;return f=new Et({}),N=new vt({props:{$$slots:{default:[wt]},$$scope:{ctx:oe}}}),{c(){i=s("meta"),A=w(),h=s("h1"),p=s("a"),k=s("span"),it(f.$$.fragment),O=w(),C=s("span"),$=o("Create a dataset card"),M=w(),m=s("p"),D=o(`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 `),c=s("a"),Y=o("Mitchell, 2018"),B=o(`.
Dataset cards help users understand a dataset\u2019s contents, the context for using the dataset, how it was created, and any other considerations a user should be aware of.`),S=w(),J=s("p"),he=o("Creating a dataset card is easy and can be done in a just a few steps:"),re=w(),y=s("ol"),K=s("li"),_=s("p"),ue=o("Go to your dataset repository on the "),R=s("a"),fe=o("Hub"),pe=o(" and click on "),Q=s("strong"),me=o("Create Dataset Card"),ye=o(" to create a new "),V=s("code"),ge=o("README.md"),_e=o(" file in your repository."),ve=w(),G=s("li"),L=s("p"),Ee=o("Use the "),W=s("strong"),we=o("Metadata UI"),be=o(" 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."),ke=w(),it(N.$$.fragment),Ce=w(),X=s("li"),v=s("p"),$e=o("Click on the "),Z=s("strong"),De=o("Import dataset card template"),Ae=o(" 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 "),F=s("a"),Me=o("Dataset Card Creation Guide"),Ne=o(" for more detailed information about what to include in each section of the card. For fields you are unable to complete, you can write "),ee=s("strong"),Te=o("[More Information Needed]"),Ie=o("."),Pe=w(),te=s("li"),q=s("p"),xe=o("Once you\u2019re done, commit the changes to the "),ae=s("code"),Oe=o("README.md"),Se=o(" file and you\u2019ll see the completed dataset card on your repository."),se=w(),g=s("p"),Re=o("Feel free to take a look at the "),H=s("a"),Ge=o("SNLI"),Le=o(", "),U=s("a"),Fe=o("CNN/DailyMail"),qe=o(", and "),j=s("a"),He=o("Allocin\xE9"),Ue=o(" dataset cards as examples to help you get started."),this.h()},l(a){const u=gt('[data-svelte="svelte-1phssyn"]',document.head);i=l(u,"META",{name:!0,content:!0}),u.forEach(t),A=b(a),h=l(a,"H1",{class:!0});var z=n(h);p=l(z,"A",{id:!0,class:!0,href:!0});var je=n(p);k=l(je,"SPAN",{});var ze=n(k);dt(f.$$.fragment,ze),ze.forEach(t),je.forEach(t),O=b(z),C=l(z,"SPAN",{});var Ye=n(C);$=r(Ye,"Create a dataset card"),Ye.forEach(t),z.forEach(t),M=b(a),m=l(a,"P",{});var ne=n(m);D=r(ne,`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 `),c=l(ne,"A",{href:!0,rel:!0});var Be=n(c);Y=r(Be,"Mitchell, 2018"),Be.forEach(t),B=r(ne,`.
Dataset cards help users understand a dataset\u2019s contents, the context for using the dataset, how it was created, and any other considerations a user should be aware of.`),ne.forEach(t),S=b(a),J=l(a,"P",{});var Je=n(J);he=r(Je,"Creating a dataset card is easy and can be done in a just a few steps:"),Je.forEach(t),re=b(a),y=l(a,"OL",{});var T=n(y);K=l(T,"LI",{});var Ke=n(K);_=l(Ke,"P",{});var I=n(_);ue=r(I,"Go to your dataset repository on the "),R=l(I,"A",{href:!0,rel:!0});var Qe=n(R);fe=r(Qe,"Hub"),Qe.forEach(t),pe=r(I," and click on "),Q=l(I,"STRONG",{});var Ve=n(Q);me=r(Ve,"Create Dataset Card"),Ve.forEach(t),ye=r(I," to create a new "),V=l(I,"CODE",{});var We=n(V);ge=r(We,"README.md"),We.forEach(t),_e=r(I," file in your repository."),I.forEach(t),Ke.forEach(t),ve=b(T),G=l(T,"LI",{});var ie=n(G);L=l(ie,"P",{});var de=n(L);Ee=r(de,"Use the "),W=l(de,"STRONG",{});var Xe=n(W);we=r(Xe,"Metadata UI"),Xe.forEach(t),be=r(de," 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."),de.forEach(t),ke=b(ie),dt(N.$$.fragment,ie),ie.forEach(t),Ce=b(T),X=l(T,"LI",{});var Ze=n(X);v=l(Ze,"P",{});var P=n(v);$e=r(P,"Click on the "),Z=l(P,"STRONG",{});var et=n(Z);De=r(et,"Import dataset card template"),et.forEach(t),Ae=r(P," 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 "),F=l(P,"A",{href:!0,rel:!0});var tt=n(F);Me=r(tt,"Dataset Card Creation Guide"),tt.forEach(t),Ne=r(P," for more detailed information about what to include in each section of the card. For fields you are unable to complete, you can write "),ee=l(P,"STRONG",{});var at=n(ee);Te=r(at,"[More Information Needed]"),at.forEach(t),Ie=r(P,"."),P.forEach(t),Ze.forEach(t),Pe=b(T),te=l(T,"LI",{});var ot=n(te);q=l(ot,"P",{});var ce=n(q);xe=r(ce,"Once you\u2019re done, commit the changes to the "),ae=l(ce,"CODE",{});var rt=n(ae);Oe=r(rt,"README.md"),rt.forEach(t),Se=r(ce," file and you\u2019ll see the completed dataset card on your repository."),ce.forEach(t),ot.forEach(t),T.forEach(t),se=b(a),g=l(a,"P",{});var x=n(g);Re=r(x,"Feel free to take a look at the "),H=l(x,"A",{href:!0,rel:!0});var st=n(H);Ge=r(st,"SNLI"),st.forEach(t),Le=r(x,", "),U=l(x,"A",{href:!0,rel:!0});var lt=n(U);Fe=r(lt,"CNN/DailyMail"),lt.forEach(t),qe=r(x,", and "),j=l(x,"A",{href:!0,rel:!0});var nt=n(j);He=r(nt,"Allocin\xE9"),nt.forEach(t),Ue=r(x," dataset cards as examples to help you get started."),x.forEach(t),this.h()},h(){d(i,"name","hf:doc:metadata"),d(i,"content",JSON.stringify(kt)),d(p,"id","create-a-dataset-card"),d(p,"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"),d(p,"href","#create-a-dataset-card"),d(h,"class","relative group"),d(c,"href","https://arxiv.org/abs/1810.03993"),d(c,"rel","nofollow"),d(R,"href","https://hf.co/new-dataset"),d(R,"rel","nofollow"),d(F,"href","https://github.com/huggingface/datasets/blob/main/templates/README_guide.md"),d(F,"rel","nofollow"),d(H,"href","https://huggingface.co/datasets/snli"),d(H,"rel","nofollow"),d(U,"href","https://huggingface.co/datasets/cnn_dailymail"),d(U,"rel","nofollow"),d(j,"href","https://huggingface.co/datasets/allocine"),d(j,"rel","nofollow")},m(a,u){e(document.head,i),E(a,A,u),E(a,h,u),e(h,p),e(p,k),ct(f,k,null),e(h,O),e(h,C),e(C,$),E(a,M,u),E(a,m,u),e(m,D),e(m,c),e(c,Y),e(m,B),E(a,S,u),E(a,J,u),e(J,he),E(a,re,u),E(a,y,u),e(y,K),e(K,_),e(_,ue),e(_,R),e(R,fe),e(_,pe),e(_,Q),e(Q,me),e(_,ye),e(_,V),e(V,ge),e(_,_e),e(y,ve),e(y,G),e(G,L),e(L,Ee),e(L,W),e(W,we),e(L,be),e(G,ke),ct(N,G,null),e(y,Ce),e(y,X),e(X,v),e(v,$e),e(v,Z),e(Z,De),e(v,Ae),e(v,F),e(F,Me),e(v,Ne),e(v,ee),e(ee,Te),e(v,Ie),e(y,Pe),e(y,te),e(te,q),e(q,xe),e(q,ae),e(ae,Oe),e(q,Se),E(a,se,u),E(a,g,u),e(g,Re),e(g,H),e(H,Ge),e(g,Le),e(g,U),e(U,Fe),e(g,qe),e(g,j),e(j,He),e(g,Ue),le=!0},p(a,[u]){const z={};u&2&&(z.$$scope={dirty:u,ctx:a}),N.$set(z)},i(a){le||(ht(f.$$.fragment,a),ht(N.$$.fragment,a),le=!0)},o(a){ut(f.$$.fragment,a),ut(N.$$.fragment,a),le=!1},d(a){t(i),a&&t(A),a&&t(h),ft(f),a&&t(M),a&&t(m),a&&t(S),a&&t(J),a&&t(re),a&&t(y),ft(N),a&&t(se),a&&t(g)}}}const kt={local:"create-a-dataset-card",title:"Create a dataset card"};function Ct(oe){return _t(()=>{new URLSearchParams(window.location.search).get("fw")}),[]}class Mt extends pt{constructor(i){super();mt(this,i,Ct,bt,yt,{})}}export{Mt as default,kt as metadata};
