update

README.md

@@ -0,0 +1,118 @@
+---
+license: cc-by-4-0
+pretty_name: SQuAD-es for question generation
+languages: es
+multilinguality: monolingual
+size_categories: 10K<n<100K
+source_datasets: squad_es
+task_categories: question-generation
+task_ids: question-generation
+---
+
+# Dataset Card for "qg_esquad"
+
+## 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 [SQuAD-es](https://huggingface.co/datasets/squad_es) 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
+Spanish (es)
+
+## Dataset Structure
+### Data Instances
+#### plain_text
+An example of 'train' looks as follows.
+```
+{
+  "question": "What is heresy mainly at odds with?",
+  "paragraph": "Heresy is any provocative belief or theory that is strongly at variance with established beliefs or customs. A heretic is a proponent of such claims or beliefs. Heresy is distinct from both apostasy, which is the explicit renunciation of one's religion, principles or cause, and blasphemy, which is an impious utterance or action concerning God or sacred things.",
+  "answer": "established beliefs or customs",
+  "sentence": "Heresy is any provocative belief or theory that is strongly at variance with established beliefs or customs .",
+  "paragraph_sentence": "<hl> Heresy is any provocative belief or theory that is strongly at variance with established beliefs or customs . <hl> A heretic is a proponent of such claims or beliefs. Heresy is distinct from both apostasy, which is the explicit renunciation of one's religion, principles or cause, and blasphemy, which is an impious utterance or action concerning God or sacred things.",
+  "paragraph_answer": "Heresy is any provocative belief or theory that is strongly at variance with <hl> established beliefs or customs <hl>. A heretic is a proponent of such claims or beliefs. Heresy is distinct from both apostasy, which is the explicit renunciation of one's religion, principles or cause, and blasphemy, which is an impious utterance or action concerning God or sacred things.",
+  "sentence_answer": "Heresy is any provocative belief or theory that is strongly at variance with <hl> established beliefs or customs <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|46306|     8511 |8579 |
+
+## 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)