Created dataset card snli.md
MEMBER
Adding a direct link to the rendered markdown:
https://github.com/mcmillanmajora/datasets/blob/add_dataset_documentation/datasets/snli/README.md

2020-09-23T22:35:27Z
https://github.com/huggingface/datasets/pull/663#issuecomment-698007013
https://api.github.com/repos/huggingface/datasets/issues/663
MDEyOklzc3VlQ29tbWVudDY5ODAwNzAxMw==
https://api.github.com/repos/huggingface/datasets/issues/comments/698007013/reactions
2020-09-28T18:07:00Z
https://api.github.com/repos/huggingface/datasets/issues/comments/698007013
https://avatars.githubusercontent.com/u/10469459?v=4
https://api.github.com/users/yjernite/events{/privacy}
https://api.github.com/users/yjernite/followers
https://api.github.com/users/yjernite/following{/other_user}
https://api.github.com/users/yjernite/gists{/gist_id}
https://github.com/yjernite
yjernite
MDQ6VXNlcjEwNDY5NDU5
https://api.github.com/users/yjernite/orgs
https://api.github.com/users/yjernite/received_events
https://api.github.com/users/yjernite/repos
https://api.github.com/users/yjernite/starred{/owner}{/repo}
https://api.github.com/users/yjernite/subscriptions
User
https://api.github.com/users/yjernite
public
MEMBER
It would be amazing if we ended up with this much information on all of our datasets :) 

I don't think there's too much repetition, everything that is in here is relevant. The main challenge will be to figure out how to structure the sheet so that all of the information can be presented without overwhelming the reader. We'll also want to have as much of it as possible in structured form so it can be easily navigated.
2020-09-23T22:56:24Z
https://github.com/huggingface/datasets/pull/663#issuecomment-698013348
https://api.github.com/repos/huggingface/datasets/issues/663
MDEyOklzc3VlQ29tbWVudDY5ODAxMzM0OA==
https://api.github.com/repos/huggingface/datasets/issues/comments/698013348/reactions
2020-09-23T22:56:24Z
https://api.github.com/repos/huggingface/datasets/issues/comments/698013348
https://avatars.githubusercontent.com/u/10469459?v=4
https://api.github.com/users/yjernite/events{/privacy}
https://api.github.com/users/yjernite/followers
https://api.github.com/users/yjernite/following{/other_user}
https://api.github.com/users/yjernite/gists{/gist_id}
https://github.com/yjernite
yjernite
MDQ6VXNlcjEwNDY5NDU5
https://api.github.com/users/yjernite/orgs
https://api.github.com/users/yjernite/received_events
https://api.github.com/users/yjernite/repos
https://api.github.com/users/yjernite/starred{/owner}{/repo}
https://api.github.com/users/yjernite/subscriptions
User
https://api.github.com/users/yjernite
public
MEMBER
@mcmillanmajora for now can you remove the prompts / quoted blocks so we can see what the datasheet would look like on its own?

Would also love to hear if @sgugger has some first impressions
2020-09-23T22:57:39Z
https://github.com/huggingface/datasets/pull/663#issuecomment-698013729
https://api.github.com/repos/huggingface/datasets/issues/663
MDEyOklzc3VlQ29tbWVudDY5ODAxMzcyOQ==
https://api.github.com/repos/huggingface/datasets/issues/comments/698013729/reactions
2020-09-23T22:57:39Z
https://api.github.com/repos/huggingface/datasets/issues/comments/698013729
https://avatars.githubusercontent.com/u/10469459?v=4
https://api.github.com/users/yjernite/events{/privacy}
https://api.github.com/users/yjernite/followers
https://api.github.com/users/yjernite/following{/other_user}
https://api.github.com/users/yjernite/gists{/gist_id}
https://github.com/yjernite
yjernite
MDQ6VXNlcjEwNDY5NDU5
https://api.github.com/users/yjernite/orgs
https://api.github.com/users/yjernite/received_events
https://api.github.com/users/yjernite/repos
https://api.github.com/users/yjernite/starred{/owner}{/repo}
https://api.github.com/users/yjernite/subscriptions
User
https://api.github.com/users/yjernite
public
CONTRIBUTOR
I removed the prompts. It's definitely a little easier to read without them!
2020-09-24T01:12:20Z
https://github.com/huggingface/datasets/pull/663#issuecomment-698053237
https://api.github.com/repos/huggingface/datasets/issues/663
MDEyOklzc3VlQ29tbWVudDY5ODA1MzIzNw==
https://api.github.com/repos/huggingface/datasets/issues/comments/698053237/reactions
2020-09-24T01:12:20Z
https://api.github.com/repos/huggingface/datasets/issues/comments/698053237
https://avatars.githubusercontent.com/u/26722925?v=4
https://api.github.com/users/mcmillanmajora/events{/privacy}
https://api.github.com/users/mcmillanmajora/followers
https://api.github.com/users/mcmillanmajora/following{/other_user}
https://api.github.com/users/mcmillanmajora/gists{/gist_id}
https://github.com/mcmillanmajora
mcmillanmajora
MDQ6VXNlcjI2NzIyOTI1
https://api.github.com/users/mcmillanmajora/orgs
https://api.github.com/users/mcmillanmajora/received_events
https://api.github.com/users/mcmillanmajora/repos
https://api.github.com/users/mcmillanmajora/starred{/owner}{/repo}
https://api.github.com/users/mcmillanmajora/subscriptions
User
https://api.github.com/users/mcmillanmajora
public
MEMBER
Should we name the file `README.md` for consistency with models?
2020-09-24T12:47:29Z
https://github.com/huggingface/datasets/pull/663#issuecomment-698321829
https://api.github.com/repos/huggingface/datasets/issues/663
MDEyOklzc3VlQ29tbWVudDY5ODMyMTgyOQ==
https://api.github.com/repos/huggingface/datasets/issues/comments/698321829/reactions
2020-09-24T12:47:29Z
https://api.github.com/repos/huggingface/datasets/issues/comments/698321829
https://avatars.githubusercontent.com/u/326577?v=4
https://api.github.com/users/julien-c/events{/privacy}
https://api.github.com/users/julien-c/followers
https://api.github.com/users/julien-c/following{/other_user}
https://api.github.com/users/julien-c/gists{/gist_id}
https://github.com/julien-c
julien-c
MDQ6VXNlcjMyNjU3Nw==
https://api.github.com/users/julien-c/orgs
https://api.github.com/users/julien-c/received_events
https://api.github.com/users/julien-c/repos
https://api.github.com/users/julien-c/starred{/owner}{/repo}
https://api.github.com/users/julien-c/subscriptions
User
https://api.github.com/users/julien-c
public
MEMBER
Asked @sleepinyourhat for some insights too :) 
2020-09-28T18:26:18Z
https://github.com/huggingface/datasets/pull/663#issuecomment-700205004
https://api.github.com/repos/huggingface/datasets/issues/663
MDEyOklzc3VlQ29tbWVudDcwMDIwNTAwNA==
https://api.github.com/repos/huggingface/datasets/issues/comments/700205004/reactions
2020-09-28T18:26:18Z
https://api.github.com/repos/huggingface/datasets/issues/comments/700205004
https://avatars.githubusercontent.com/u/10469459?v=4
https://api.github.com/users/yjernite/events{/privacy}
https://api.github.com/users/yjernite/followers
https://api.github.com/users/yjernite/following{/other_user}
https://api.github.com/users/yjernite/gists{/gist_id}
https://github.com/yjernite
yjernite
MDQ6VXNlcjEwNDY5NDU5
https://api.github.com/users/yjernite/orgs
https://api.github.com/users/yjernite/received_events
https://api.github.com/users/yjernite/repos
https://api.github.com/users/yjernite/starred{/owner}{/repo}
https://api.github.com/users/yjernite/subscriptions
User
https://api.github.com/users/yjernite
public
CONTRIBUTOR
Thank you for taking the time to look through the card and for all your comments @sleepinyourhat ! I've incorporated them in the latest update.  
2020-09-30T20:32:26Z
https://github.com/huggingface/datasets/pull/663#issuecomment-701628853
https://api.github.com/repos/huggingface/datasets/issues/663
MDEyOklzc3VlQ29tbWVudDcwMTYyODg1Mw==
https://api.github.com/repos/huggingface/datasets/issues/comments/701628853/reactions
2020-09-30T20:32:26Z
https://api.github.com/repos/huggingface/datasets/issues/comments/701628853
https://avatars.githubusercontent.com/u/26722925?v=4
https://api.github.com/users/mcmillanmajora/events{/privacy}
https://api.github.com/users/mcmillanmajora/followers
https://api.github.com/users/mcmillanmajora/following{/other_user}
https://api.github.com/users/mcmillanmajora/gists{/gist_id}
https://github.com/mcmillanmajora
mcmillanmajora
MDQ6VXNlcjI2NzIyOTI1
https://api.github.com/users/mcmillanmajora/orgs
https://api.github.com/users/mcmillanmajora/received_events
https://api.github.com/users/mcmillanmajora/repos
https://api.github.com/users/mcmillanmajora/starred{/owner}{/repo}
https://api.github.com/users/mcmillanmajora/subscriptions
User
https://api.github.com/users/mcmillanmajora
public
NONE
Be careful to keep the ‘sa’ term in the license. It’s something we
inherited from the Flickr captions.

On Thu, Oct 1, 2020 at 10:09 AM Julien Chaumond <notifications@github.com>
wrote:

> *@julien-c* commented on this pull request.
> ------------------------------
>
> In datasets/snli/README.md
> <https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_huggingface_datasets_pull_663-23discussion-5Fr498273172&d=DwMFaQ&c=slrrB7dE8n7gBJbeO0g-IQ&r=sCzLyHdE8zgQwk2-sKwA1w&m=PHPCew9Xj3CBQrudcaii70ln-wpRtbngE_tj3Ioy3NI&s=WbEkKXCbL6j5Ui3sox_WqvzrbShbJn2WW-51SENL2ZQ&e=>
> :
>
> > +---
> +language:
> +- en
> +task:
> +- text-classification
> +purpose:
> +- NLI
> +size:
> +- ">100k"
> +language producers:
> +- crowdsourced
> +annotation:
> +- crowdsourced
> +tags:
> +- extended-from-other-datasets
> +license: "CC BY-SA 4.0"
>
> ⬇️ Suggested change
>
> -license: "CC BY-SA 4.0"
> +license: cc-by-4.0
>
> For models (documented at
> https://huggingface.co/docs#what-metadata-can-i-add-to-my-model-card
> <https://urldefense.proofpoint.com/v2/url?u=https-3A__huggingface.co_docs-23what-2Dmetadata-2Dcan-2Di-2Dadd-2Dto-2Dmy-2Dmodel-2Dcard&d=DwMFaQ&c=slrrB7dE8n7gBJbeO0g-IQ&r=sCzLyHdE8zgQwk2-sKwA1w&m=PHPCew9Xj3CBQrudcaii70ln-wpRtbngE_tj3Ioy3NI&s=ck3x8c_ujrwKReDTSGuWWgD9W6REHEPbZaO7S4GFRd4&e=>)
> we use the License keywords listed by GitHub at
> https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/licensing-a-repository#searching-github-by-license-type
> <https://urldefense.proofpoint.com/v2/url?u=https-3A__docs.github.com_en_free-2Dpro-2Dteam-40latest_github_creating-2Dcloning-2Dand-2Darchiving-2Drepositories_licensing-2Da-2Drepository-23searching-2Dgithub-2Dby-2Dlicense-2Dtype&d=DwMFaQ&c=slrrB7dE8n7gBJbeO0g-IQ&r=sCzLyHdE8zgQwk2-sKwA1w&m=PHPCew9Xj3CBQrudcaii70ln-wpRtbngE_tj3Ioy3NI&s=dWBP-ZvtMErD-egoBiBTCKA4500mjDXVSk03oW1g16U&e=>
>
> (Hopefully we'll plug some sort of form validation for users at some point)
>
> —
> You are receiving this because you were mentioned.
> Reply to this email directly, view it on GitHub
> <https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_huggingface_datasets_pull_663-23pullrequestreview-2D500386385&d=DwMFaQ&c=slrrB7dE8n7gBJbeO0g-IQ&r=sCzLyHdE8zgQwk2-sKwA1w&m=PHPCew9Xj3CBQrudcaii70ln-wpRtbngE_tj3Ioy3NI&s=HU2Hwi7HH9W2NtMoCIiQlhXxxEULLi8L9gnWU5PBAPY&e=>,
> or unsubscribe
> <https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_notifications_unsubscribe-2Dauth_AAJZSWL63W2LB7SBICA2GMTSISEPZANCNFSM4RWKAZRA&d=DwMFaQ&c=slrrB7dE8n7gBJbeO0g-IQ&r=sCzLyHdE8zgQwk2-sKwA1w&m=PHPCew9Xj3CBQrudcaii70ln-wpRtbngE_tj3Ioy3NI&s=086__lKQLxTanHfjE8kOIpaJbaWPzBB9gGIt_prWeH8&e=>
> .
>

2020-10-01T14:12:17Z
https://github.com/huggingface/datasets/pull/663#issuecomment-702163908
https://api.github.com/repos/huggingface/datasets/issues/663
MDEyOklzc3VlQ29tbWVudDcwMjE2MzkwOA==
https://api.github.com/repos/huggingface/datasets/issues/comments/702163908/reactions
2020-10-01T14:12:17Z
https://api.github.com/repos/huggingface/datasets/issues/comments/702163908
https://avatars.githubusercontent.com/u/1284441?v=4
https://api.github.com/users/sleepinyourhat/events{/privacy}
https://api.github.com/users/sleepinyourhat/followers
https://api.github.com/users/sleepinyourhat/following{/other_user}
https://api.github.com/users/sleepinyourhat/gists{/gist_id}
https://github.com/sleepinyourhat
sleepinyourhat
MDQ6VXNlcjEyODQ0NDE=
https://api.github.com/users/sleepinyourhat/orgs
https://api.github.com/users/sleepinyourhat/received_events
https://api.github.com/users/sleepinyourhat/repos
https://api.github.com/users/sleepinyourhat/starred{/owner}{/repo}
https://api.github.com/users/sleepinyourhat/subscriptions
User
https://api.github.com/users/sleepinyourhat
public
MEMBER
@sleepinyourhat You're right, wrong copy/paste
2020-10-01T14:14:23Z
https://github.com/huggingface/datasets/pull/663#issuecomment-702165239
https://api.github.com/repos/huggingface/datasets/issues/663
MDEyOklzc3VlQ29tbWVudDcwMjE2NTIzOQ==
https://api.github.com/repos/huggingface/datasets/issues/comments/702165239/reactions
2020-10-01T14:14:23Z
https://api.github.com/repos/huggingface/datasets/issues/comments/702165239
https://avatars.githubusercontent.com/u/326577?v=4
https://api.github.com/users/julien-c/events{/privacy}
https://api.github.com/users/julien-c/followers
https://api.github.com/users/julien-c/following{/other_user}
https://api.github.com/users/julien-c/gists{/gist_id}
https://github.com/julien-c
julien-c
MDQ6VXNlcjMyNjU3Nw==
https://api.github.com/users/julien-c/orgs
https://api.github.com/users/julien-c/received_events
https://api.github.com/users/julien-c/repos
https://api.github.com/users/julien-c/starred{/owner}{/repo}
https://api.github.com/users/julien-c/subscriptions
User
https://api.github.com/users/julien-c
public
NONE
Question: Where does this standard come from? It looks similar to both
'Data Statements' and 'Datasheets for Datasets', but it doesn't look quite
like either.

On Mon, Oct 12, 2020 at 4:27 PM Yacine Jernite <notifications@github.com>
wrote:

> Merged #663
> <https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_huggingface_datasets_pull_663&d=DwMCaQ&c=slrrB7dE8n7gBJbeO0g-IQ&r=sCzLyHdE8zgQwk2-sKwA1w&m=D34WbiHBTYHOdXsI9JV9wJqSieP6zAPGqGKDziM5uKU&s=s4_X-BSEnTKgGg9rPLBt3cyVptyMX_iWD5Ql3UMBi-I&e=>
> into master.
>
> —
> You are receiving this because you were mentioned.
> Reply to this email directly, view it on GitHub
> <https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_huggingface_datasets_pull_663-23event-2D3868180429&d=DwMCaQ&c=slrrB7dE8n7gBJbeO0g-IQ&r=sCzLyHdE8zgQwk2-sKwA1w&m=D34WbiHBTYHOdXsI9JV9wJqSieP6zAPGqGKDziM5uKU&s=elcM4umqReQfIrgHhpey9W_wPaq5QRgq7xNlubM47QI&e=>,
> or unsubscribe
> <https://urldefense.proofpoint.com/v2/url?u=https-3A__github.com_notifications_unsubscribe-2Dauth_AAJZSWJVGQRCR4OTTV27VTTSKNRBXANCNFSM4RWKAZRA&d=DwMCaQ&c=slrrB7dE8n7gBJbeO0g-IQ&r=sCzLyHdE8zgQwk2-sKwA1w&m=D34WbiHBTYHOdXsI9JV9wJqSieP6zAPGqGKDziM5uKU&s=NB6nEROnTPgwNyF3ZklOmHnvP7kOkOm7sEa740KbVCs&e=>
> .
>

2020-10-12T23:04:17Z
https://github.com/huggingface/datasets/pull/663#issuecomment-707387925
https://api.github.com/repos/huggingface/datasets/issues/663
MDEyOklzc3VlQ29tbWVudDcwNzM4NzkyNQ==
https://api.github.com/repos/huggingface/datasets/issues/comments/707387925/reactions
2020-10-12T23:04:17Z
https://api.github.com/repos/huggingface/datasets/issues/comments/707387925
https://avatars.githubusercontent.com/u/1284441?v=4
https://api.github.com/users/sleepinyourhat/events{/privacy}
https://api.github.com/users/sleepinyourhat/followers
https://api.github.com/users/sleepinyourhat/following{/other_user}
https://api.github.com/users/sleepinyourhat/gists{/gist_id}
https://github.com/sleepinyourhat
sleepinyourhat
MDQ6VXNlcjEyODQ0NDE=
https://api.github.com/users/sleepinyourhat/orgs
https://api.github.com/users/sleepinyourhat/received_events
https://api.github.com/users/sleepinyourhat/repos
https://api.github.com/users/sleepinyourhat/starred{/owner}{/repo}
https://api.github.com/users/sleepinyourhat/subscriptions
User
https://api.github.com/users/sleepinyourhat
public
CONTRIBUTOR
@sleepinyourhat The schema is definitely drawing from Data Statements and Datasheets for Datasets but we also wanted to include some more general information to introduce the dataset to new users. If you have any suggestions for changes to the schema itself, please let us know!
2020-10-13T17:05:20Z
https://github.com/huggingface/datasets/pull/663#issuecomment-707882992
https://api.github.com/repos/huggingface/datasets/issues/663
MDEyOklzc3VlQ29tbWVudDcwNzg4Mjk5Mg==
https://api.github.com/repos/huggingface/datasets/issues/comments/707882992/reactions
2020-10-13T17:05:20Z
https://api.github.com/repos/huggingface/datasets/issues/comments/707882992
https://avatars.githubusercontent.com/u/26722925?v=4
https://api.github.com/users/mcmillanmajora/events{/privacy}
https://api.github.com/users/mcmillanmajora/followers
https://api.github.com/users/mcmillanmajora/following{/other_user}
https://api.github.com/users/mcmillanmajora/gists{/gist_id}
https://github.com/mcmillanmajora
mcmillanmajora
MDQ6VXNlcjI2NzIyOTI1
https://api.github.com/users/mcmillanmajora/orgs
https://api.github.com/users/mcmillanmajora/received_events
https://api.github.com/users/mcmillanmajora/repos
https://api.github.com/users/mcmillanmajora/starred{/owner}{/repo}
https://api.github.com/users/mcmillanmajora/subscriptions
User
https://api.github.com/users/mcmillanmajora
public
First draft of a dataset card using the SNLI corpus as an example.

This is mostly based on the [Google Doc draft](https://docs.google.com/document/d/1dKPGP-dA2W0QoTRGfqQ5eBp0CeSsTy7g2yM8RseHtos/edit), but I added a few sections and moved some things around. 

- I moved **Who Was Involved** to follow **Language**, both because I thought the authors should be presented more towards the front and because I think it makes sense to present the speakers close to the language so it doesn't have to be repeated.

- I created a section I called **Data Characteristics** by pulling some things out of the other sections. I was thinking that this would be more about the language use in context of the specific task construction. That name isn't very descriptive though and could probably be improved.
-- Domain and language type out of **Language**. I particularly wanted to keep the Language section as simple and as abstracted from the task as possible.
-- 'How was the data collected' out of **Who Was Involved** 
-- Normalization out of **Features/Dataset Structure** 
-- I also added an annotation process section.

- I kept the **Features** section mostly the same as the Google Doc, but I renamed it **Dataset Structure** to more clearly separate it from the language use, and added some links to the documentation pages. 

- I also kept **Tasks Supported**,  **Known Limitations**, and **Licensing Information** mostly the same. Looking at it again though, maybe **Tasks Supported** should come before **Data Characteristics**?

The trickiest part about writing a dataset card for the SNLI corpus specifically is that it's built on datasets which are themselves built on datasets so I had to dig in a lot of places to find information. I think this will be easier with other datasets and once there is more uptake of dataset cards so they can just link to each other. (Maybe that needs to be an added section?)

I also made an effort not to repeat information across the sections or to refer to a previous section if the information was relevant in a later one. Is there too much repetition still?