Update README.md

README.md

@@ -0,0 +1,118 @@
+---
+license: cc-by-4-0
+pretty_name: SberQuAD for question generation
+languages: ru
+multilinguality: monolingual
+size_categories: 10K<n<100K
+source_datasets: deepset/germanquad
+task_categories: question-generation
+task_ids: question-generation
+---
+
+# Dataset Card for "qg_ruquad"
+
+## Table of Contents
+- [Dataset Description](#dataset-description)
+  - [Dataset Summary](#dataset-summary)
+  - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
+  - [Languages](#languages)
+- [Dataset Structure](#dataset-structure)
+  - [Data Instances](#data-instances)
+  - [Data Fields](#data-fields)
+  - [Data Splits](#data-splits)
+- [Dataset Creation](#dataset-creation)
+  - [Curation Rationale](#curation-rationale)
+  - [Source Data](#source-data)
+  - [Annotations](#annotations)
+  - [Personal and Sensitive Information](#personal-and-sensitive-information)
+- [Considerations for Using the Data](#considerations-for-using-the-data)
+  - [Social Impact of Dataset](#social-impact-of-dataset)
+  - [Discussion of Biases](#discussion-of-biases)
+  - [Other Known Limitations](#other-known-limitations)
+- [Additional Information](#additional-information)
+  - [Dataset Curators](#dataset-curators)
+  - [Licensing Information](#licensing-information)
+  - [Citation Information](#citation-information)
+
+## Dataset Description
+- **Repository:** [https://github.com/asahi417/lm-question-generation](https://github.com/asahi417/lm-question-generation)
+- **Paper:** [More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+- **Point of Contact:** [Asahi Ushio](http://asahiushio.com/)
+
+### Dataset Summary
+Modified version of [SberQuaD](https://huggingface.co/datasets/sberquad) for question generation (QG) task.
+Since the original dataset only contains training/validation set, we manually sample test set from training set, which
+has no overlap in terms of the paragraph with the training set.
+
+### Supported Tasks and Leaderboards
+* `question-generation`: The dataset can be used to train a model for question generation.
+  Success on this task is typically measured by achieving a high BLEU4/METEOR/ROUGE-L score.
+
+### Languages
+Russian (ru)
+
+## Dataset Structure
+### Data Instances
+#### plain_text
+An example of 'train' looks as follows.
+```
+{
+  'answer': 'известковыми выделениями сине-зелёных водорослей',                                                                                                                                                                   
+  'question': 'чем представлены органические остатки?',  
+  'sentence': 'Они представлены известковыми выделениями сине-зелёных водорослей , ходами червей, остатками кишечнополостных.'
+  'paragraph': "В протерозойских отложениях органические остатки встречаются намного чаще, чем в архейских. Они представлены..."
+  'sentence_answer': "Они представлены <hl> известковыми выделениями сине-зелёных водорослей <hl> , ход...",   
+  'paragraph_answer': "В протерозойских отложениях органические остатки встречаются намного чаще, чем в архейских. Они представлены <hl> известковыми выделениям...",
+  'paragraph_sentence': "В протерозойских отложениях органические остатки встречаются намного чаще, чем в архейских. <hl> Они представлены известковыми выделениями сине-зелёных водорослей , ходами червей, остатками кишечнополостных. <hl> Кроме..."  
+}
+```
+### Data Fields
+The data fields are the same among all splits.
+#### plain_text
+- `question`: a `string` feature. 
+- `paragraph`: a `string` feature.
+- `answer`: a `string` feature.
+- `sentence`: a `string` feature.
+- `paragraph_answer`: a `string` feature, which is same as the paragraph but the answer is highlighted by a special token `<hl>`.
+- `paragraph_sentence`: a `string` feature, which is same as the paragraph but a sentence containing the answer is highlighted by a special token `<hl>`.
+- `sentence_answer`: a `string` feature, which is same as the sentence but the answer is highlighted by a special token `<hl>`.
+
+Each of `paragraph_answer`, `paragraph_sentence`, and `sentence_answer` feature is assumed to be used to train a question generation model,
+but with different information. The `paragraph_answer` and `sentence_answer` features are for answer-aware question generation and 
+`paragraph_sentence` feature is for sentence-aware question generation.
+
+### Data Splits
+
+|   name   |train|validation|test |
+|----------|----:|---------:|----:|
+|plain_text|  |       |  |
+
+## Dataset Creation
+### Curation Rationale
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+### Source Data
+#### Initial Data Collection and Normalization
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+#### Who are the source language producers?
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+### Annotations
+#### Annotation process
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+#### Who are the annotators?
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+### Personal and Sensitive Information
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+## Considerations for Using the Data
+### Social Impact of Dataset
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+### Discussion of Biases
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+### Other Known Limitations
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+## Additional Information
+### Dataset Curators
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+### Licensing Information
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
+### Citation Information
+[More Information Needed](https://github.com/huggingface/datasets/blob/master/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)