Update README.md

README.md

@@ -20,18 +20,18 @@ Logiqa2.0 dataset - logical reasoning in MRC and NLI tasks
 
 ```
 ## About
-This is the version 2 of the LogiQA dataset, first released as a multi-choice reading comprehension dataset by our previous paper [LogiQA: A Challenge  Dataset for Machine Reading Comprehension with Logical Reasoning](https://arxiv.org/abs/2007.08124). 
+This is version 2 of the LogiQA dataset, first released as a multi-choice reading comprehension dataset by our previous paper [LogiQA: A Challenge  Dataset for Machine Reading Comprehension with Logical Reasoning](https://arxiv.org/abs/2007.08124). 
 
 The dataset is collected from the [Chinese Civil Service Entrance Examination](chinagwy.org). The dataset is both in Chinese and English (by translation). you can download the version 1 of the LogiQA dataset from [here](https://github.com/lgw863/logiqa-dataset).
 
-To construct LogiQA2.0 dataset, we:
-* collect more newly released exam questions and practice questions. There are about 20 provinces in China that hold the exam annually. The exam materials are publicly available on the Internet after the exams. Besides, practice questions are provided by various sources.
-* hire professional translators to re-translate the dataset from Chinese to English; verify the labels and annotations with human experts. This program is conducted by [Speechocean](en.speechocean.com), a data annotation service provider. The project is accomplished with the help of Microsoft Research Asia.
-* introduce a new NLI task to the dataset. The NLI version of the dataset is converted from the MRC version of the dataset, following previous work such as [Transforming Question Answering Datasets into Natural Language Inference Datasets](https://arxiv.org/abs/1809.02922).
+To construct the LogiQA2.0 dataset, we:
+* Collect more newly released exam questions and practice questions. There are about 20 provinces in China that hold the exam annually. The exam materials are publicly available on the Internet after the exams. Besides, practice questions are provided by various sources.
+* Hire professional translators to re-translate the dataset from Chinese to English; verify the labels and annotations with human experts. This program is conducted by [Speechocean](en.speechocean.com), a data annotation service provider. The project is accomplished with the help of Microsoft Research Asia.
+* Introduce a new NLI task to the dataset. The NLI version of the dataset is converted from the MRC version of the dataset, following previous work such as [Transforming Question Answering Datasets into Natural Language Inference Datasets](https://arxiv.org/abs/1809.02922).
 
 ## Datasets
 ### MRC
-The MRC part of LogiQA2.0 dataset can be found in the `/MRC/` folder.
+The MRC part of the LogiQA2.0 dataset can be found in the `/MRC/` folder.
 
 `train.txt`: train split of the dataset in json lines.
 
@@ -54,7 +54,7 @@ The MRC part of LogiQA2.0 dataset can be found in the `/MRC/` folder.
 
 An example:
 ```
-{"id": 10471, "answer": 0, "text": "The medieval Arabs had many manuscripts of the ancient Greek. When needed, they translate them into Arabic. Medieval Arab philosophers were very interested in Aristotle's Theory of Poetry, which was obviously not shared by Arab poets, because a poet interested in it must want to read Homer's poems. Aristotle himself often quotes Homer's poems. However, Homer's poems were not translated into Arabic until modern times.", "question": "Which of the following options, if true, strongly supports the above argument?", "options": ["Some medieval Arab translators have manuscripts of Homer poems in ancient Greek.", "Aristotle's Theory of Poetry is often quoted and commented by modern Arab poets.", "In Aristotle's Theory of Poetry, most of the content is related to drama, and medieval Arabs also wrote plays and performed them.", "A series of medieval Arab stories, such as Arab Night, are very similar to some parts of Homer's epic."], "type": {"Sufficient Conditional Reasoning": true, "Necessry Condtional Reasoning": true, "Conjunctive Reasoning": true}}
+{"id": 10471, "answer": 0, "text": "The medieval Arabs had many manuscripts of ancient Greek. When needed, they translate them into Arabic. Medieval Arab philosophers were very interested in Aristotle's Theory of Poetry, which was obviously not shared by Arab poets, because a poet interested in it must want to read Homer's poems. Aristotle himself often quotes Homer's poems. However, Homer's poems were not translated into Arabic until modern times.", "question": "Which of the following options, if true, strongly supports the above argument?", "options": ["Some medieval Arab translators have manuscripts of Homer poems in ancient Greek.", "Aristotle's Theory of Poetry is often quoted and commented by modern Arab poets.", "In Aristotle's Theory of Poetry, most of the content is related to drama, and medieval Arabs also wrote plays and performed them.", "A series of medieval Arab stories, such as Arab Night, are very similar to some parts of Homer's epic."], "type": {"Sufficient Conditional Reasoning": true, "Necessry Condtional Reasoning": true, "Conjunctive Reasoning": true}}
 ```
 An example of the Chinese dataset:
 ```
@@ -75,7 +75,7 @@ An example:
 {"label": "not entailed", "major_premise": ["Among the employees of a software company, there are three Cantonese, one Beijinger and three northerners"], "minor_premise": " Four are only responsible for software development and two are only responsible for product sales", "conclusion": "There may be at least 7 people and at most 12 people."}
 ```
 ## Annotations
-The translation and annotation work is outsourced to [Speechocean](en.speechocean.com), the project fund is provided by Microsoft Research Asia
+The translation and annotation work is outsourced to [Speechocean](en.speechocean.com), and the project fund is provided by Microsoft Research Asia
 ### Translation
 
 | Final Report |  |
@@ -87,43 +87,14 @@ The translation and annotation work is outsourced to [Speechocean](en.speechocea
  
 Translation style/method:
 
-1. Maintain a unified style, and the translated English questions need to inherit the logic of the original questions;
+1. Maintain a unified style, and the translated English questions need to inherit the logic of the original questions.
 
-2. The pronoun in the question need to be unique, the translation needs to be unique and consistent without ambiguity;
+2. The pronoun in the question needs to be unique, the translation needs to be unique and consistent without ambiguity;
 
 3. The translated English conforms to the form of a proper question, that is, it is a clear question from the perspective of the respondent;
 
 ### Label consistency
-The label credibility is mannually verified after the translation was done to maintain the truthfulness of the original text. 3 workers run a consistency test on each example, if 2 or more workers give different answer compared to the original answer, the translation would be redone to guareentee the label is correct.
+The label credibility is manually verified after the translation is done to maintain the truthfulness of the original text. 3 workers run a consistency test on each example, if 2 or more workers give different answer compared to the original answer, the translation would be redone to guareentee the label is correct.
 
 ### Additional annotations
-Reasoning types of each question is assigned by a total of 5 workers, each of them corresponds to one reasoning type. We give the description of reasoning types (which can be found in our paper) to the workers. The reasoning types of each question is a collection of 5 workers' decision.
-## Baseline Guidance
-### Requirements
-* python 3.6+
-* pytorch 1.0+
-* transformers 2.4.1
-* sklearn
-* tqdm
-* tensorboardX
-
-We recommend to use conda to manage virtual environments:
-
-```
-conda env update --name logiqa --file requirements.yml
-```
-### Logiqa
-The folder `logiqa` contains both the code and data to run baseline experiments of LogiQA2.0 MRC.
-
-To fine-tune the dataset, type following command from the terminal in your :computer:
-```
-bash logiqa.sh
-```
-### Logiqa2nli
-The folder `logiqa2nli` contains both the code and data to run baseline experiments of LogiQA2.0 NLI.
-
-To fine-tune the dataset, type following command from the terminal in your :computer:
-```
-bash qa2nli.sh
-```
-Note: `./scripts` contains the scripts for running other NLI benchmarks.
+The reasoning types of each question are assigned by a total of 5 workers, each of whom corresponds to one reasoning type. We describe reasoning types (which can be found in our paper) to the workers. The reasoning types of each question is a collection of 5 workers' decision.