Update README.md

README.md

@@ -1,3 +1,64 @@
----
-license: cc-by-4.0
----
+---
+license: cc-by-4.0
+---
+---
+# Dataset Card for Dataset Name
+
+<!-- Provide a quick summary of the dataset. -->
+
+This dataset card aims to be a base template for new datasets. It has been generated using [this raw template](https://github.com/huggingface/huggingface_hub/blob/main/src/huggingface_hub/templates/datasetcard_template.md?plain=1).
+
+## Dataset Details
+
+### Dataset Description
+
+<!-- Provide a longer summary of what this dataset is. -->
+
+# CleanComedy
+
+Humour generation is a challenging task in natural language processing due to limited resources and the quality of existing datasets. Available humour language resources often suffer from toxicity and duplication, limiting their effectiveness for training robust models. In this paper, we present CleanComedy, a specialised, partially annotated corpus, which includes jokes in English and Russian languages. The dataset is a filtered collection of existing sources, where toxic jokes and duplicates are removed with various algorithmic filters. The end quality of the dataset is validated with human assessment. We also present subjective human  humour score annotation for 1,000 Russian and 1,000 English jokes providing detailed, ethical and comprehensive dataset for humour detection and generation tasks.
+
+
+- **Curated by:** Dmitry Vikhorev, Daria Galimzianova, Svetlana Gorovaia, Elizaveta Zhemchuzhina, Ivan P. Yamshchikov
+- **Language(s) (NLP):** English, Russian
+- **License:** CC-BY-4.0
+
+### Dataset Sources [optional]
+
+<!-- Provide the basic links for the dataset. -->
+
+- **Repository:** (https://github.com/gorovuha/CleanComedy)
+- **Paper [optional]:** [CleanComedy: Creating Friendly Humor through Generative Techniques](https://arxiv.org/pdf/2412.09203)
+
+## Dataset Structure
+
+<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
+
+### CleanComedy English 
+Ethical filtered jokes with 2-scale score 
+44,481 instances
+
+### CleanComedy English Gold 
+Ethical filtered jokes with human humour 5-scale score
+1,000 instances
+
+### CleanComedy Russian 
+Ethical filtered jokes with 2-scale score 
+40,926 instances
+
+
+### CleanComedy Russian Gold 
+Ethical filtered jokes with human humour 5-scale score
+1,000 instances
+
+**BibTeX:**
+
+@misc{vikhorev2024cleancomedycreatingfriendlyhumor,
+      title={CleanComedy: Creating Friendly Humor through Generative Techniques}, 
+      author={Dmitry Vikhorev and Daria Galimzianova and Svetlana Gorovaia and Elizaveta Zhemchuzhina and Ivan P. Yamshchikov},
+      year={2024},
+      eprint={2412.09203},
+      archivePrefix={arXiv},
+      primaryClass={cs.CL},
+      url={https://arxiv.org/abs/2412.09203}, 
+}