Upload README.md

README.md

@@ -1,3 +1,58 @@
----
-license: cc-by-nc-4.0
----
+
+#### SPOLIN is provided in JSON format
+[![CC BY-NC 4.0][cc-by-nc-shield]][cc-by-nc]
+
+
+**First level keys:**
+* `yesands`
+* `non-yesands`
+
+**Second level keys:**
+* `spont`: shorthand for Spontaneanation
+* `cornell`: shorthand for Cornell Movie-Dialogs Corpus 
+* `subtle`: (not present in `spolin-valid.json`) shorthand for  SubTle Corpus 
+
+Each second level item is a list of _yes-ands_ or non-_yes-ands_. Each item contains the following: 
+* `id`: dataset ID
+* `prompt`: Utterance that starts the dialogue turn 
+* `response`: Response to the prompt
+
+
+##### `spolin-train.json`:  
+|| yesands| non-yesands|
+|--|---:|---:|
+|Spontaneanation|10,459|5,587*|
+|Cornell|16,426|18,310|
+|SubTle|40,303|19,512|
+|Total|67,188|43,409|
+
+
+##### `spolin-train-acl.json`: 
+
+|| yesands| non-yesands|
+|--|---:|---:|
+|Spontaneanation|10,459|5,587*|
+|Cornell|14,976|17,851|
+|Total|25,435|23,438|
+
+##### `spolin-valid.json`: 
+
+|| yesands| non-yesands|
+|--|---:|---:|
+|Spontaneanation|500|500*|
+|Cornell|500|500|
+|Total|1,000|1,000|
+
+\*Artificially collected by mix & matching positive Spontaneanation samples to balance dataset for training classifier
+
+
+### License
+
+
+This work is licensed under a [Creative Commons Attribution-NonCommercial 4.0 International License][cc-by-nc].
+
+[![CC BY-NC 4.0][cc-by-nc-image]][cc-by-nc]
+
+[cc-by-nc]: http://creativecommons.org/licenses/by-nc/4.0/
+[cc-by-nc-image]: https://licensebuttons.net/l/by-nc/4.0/88x31.png
+[cc-by-nc-shield]: https://img.shields.io/badge/License-CC%20BY--NC%204.0-lightgrey.svg