Updating description of fields and statistics

README.md

@@ -14,7 +14,7 @@ task_categories:
 
 ### Dataset Summary
 
-This dataset is a set of samples for testing the spell checker, grammar error correction and ungrammatical text detection models.
+This dataset is a set of samples for training and testing the spell checking, grammar error correction and ungrammatical text detection models.
 
 The dataset contains two splits:
 
@@ -23,16 +23,14 @@ test.json contains samples hand-selected to evaluate the quality of models.
 train.json contains synthetic samples generated in various ways.
 
 The purpose of creating the dataset was to test an internal spellchecker for [a generative poetry project](https://github.com/Koziev/verslibre), but it can also be useful in other projects, since it does not have an explicit specialization for poetry.
-You can consider this dataset as an extension of [RuCOLA](https://huggingface.co/datasets/RussianNLP/rucola).
-In addition, for some samples there is a corrected version of the text ("fixed_sentence" field), so it can be used as an extension of datasets in [ai-forever/spellcheck_benchmark](https://huggingface.co/datasets/ai-forever/spellcheck_benchmark).
 
 ### Example
 
 ```
 {
         "id": 1483,
-        "sentence": "Разучи стихов по больше",
-        "fixed_sentence": "Разучи стихов побольше",
+        "text": "Разучи стихов по больше",
+        "fixed_text": "Разучи стихов побольше",
         "label": 0,
         "error_type": "Tokenization",
         "domain": "prose"
@@ -45,38 +43,25 @@ The test split contains only examples of mistakes made by people. There are no s
 
 The examples of errors in the test split come from different people in terms of gender, age, education, context, and social context.
 
-The input and output text can be not only one sentence, but also 1) part of a sentence, 2) several sentences - a paragraph, 3) a fragment of a poem, usually a quatrain or two quatrains.
+The input and output text can be not only one sentence, but also 1) a part of a sentence or incomplete dialog responses, 2) several sentences - a paragraph, 3) a fragment of a poem, usually a quatrain or two quatrains.
 
-The texts may include offensive texts, texts that offend religious or political feelings, texts that contradict moral standards, etc. Such samples are only needed to make the corpus as representative as possible for the tasks of processing messages in various media such as blogs, comments, etc.
+The texts may include offensive phrases, phrases that offend religious or political feelings, fragments that contradict moral standards, etc.
+Such samples are only needed to make the corpus as representative as possible for the tasks of processing messages
+in various media such as blogs, comments, etc.
 
 One sample may contain several errors of different types.
 
 
-
-### Uncensoring samples
-
-A number of samples contain text with explicit obscenities:
-
-```
-{
-        "id": 1,
-        "sentence": "Но не простого - с лёгкой еб@нцой.",
-        "fixed_sentence": "Но не простого - с лёгкой ебанцой.",
-        "label": 0,
-        "error_type": "Misspelling",
-        "domain": "prose"
-}
-```
-
 ### Poetry samples
 
-A few poetry samples are included in this version:
+The texts of the poems are included in the test part of the dataset, which makes it unique among similar
+datasets for the Russian language:
 
 ```
 {
         "id": 24,
-        "sentence": "Чему научит забытьё?\nСмерть формы д'арует литьё.\nРезец мгновенье любит стружка...\nСмерть безобидная подружка!",
-        "fixed_sentence": null,
+        "text": "Чему научит забытьё?\nСмерть формы д'арует литьё.\nРезец мгновенье любит стружка...\nСмерть безобидная подружка!",
+        "fixed_text": null,
         "label": 0,
         "error_type": "Grammar",
         "domain": "poetry"
@@ -88,9 +73,9 @@ A few poetry samples are included in this version:
 ### Dataset fields
 
 **id** (int64): the sentence's id, starting 1.  
-**sentence** (str): the original sentence.  
-**fixed_sentence** (str): the corrected version of original sentence.  
-**label** (str): the target class. "1" for "acceptable", "0" for "unacceptable".  
+**text** (str): the original text (part of sentence, whole sentence or several sentences).  
+**fixed_text** (str): the corrected version of original text.  
+**label** (str): the target class. "1" for "not defects", "0" for "contains defects".  
 **error_type** (str): the violation category: Spelling, Grammar, Tokenization, Punctuation, Mixture, Unknown.  
 **domain** (str): domain: "prose" or "poetry".
 
@@ -101,8 +86,8 @@ A few poetry samples are included in this version:
 ```
 {
         "id": 6,
-        "sentence": "Я подбираю по проще слова",
-        "fixed_sentence": "Я подбираю попроще слова",
+        "text": "Я ��одбираю по проще слова",
+        "fixed_text": "Я подбираю попроще слова",
         "label": 0,
         "error_type": "Tokenization",
         "domain": "prose"
@@ -114,8 +99,8 @@ A few poetry samples are included in this version:
 ```
 {
         "id": 5,
-        "sentence": "И швырнуть по-дальше",
-        "fixed_sentence": "И швырнуть подальше",
+        "text": "И швырнуть по-дальше",
+        "fixed_text": "И швырнуть подальше",
         "label": 0,
         "error_type": "Punctuation",
         "domain": "prose"
@@ -127,8 +112,8 @@ A few poetry samples are included in this version:
 ```
 {
         "id": 38,
-        "sentence": "И ведь что интересно, русские официально ни в одном крестовом позоде не участвовали.",
-        "fixed_sentence": "И ведь что интересно, русские официально ни в одном крестовом походе не участвовали.",
+        "text": "И ведь что интересно, русские официально ни в одном крестовом позоде не участвовали.",
+        "fixed_text": "И ведь что интересно, русские официально ни в одном крестовом походе не участвовали.",
         "label": 0,
         "error_type": "Spelling",
         "domain": "prose"
@@ -140,8 +125,8 @@ A few poetry samples are included in this version:
 ```
 {
         "id": 61,
-        "sentence": "на него никто не польститься",
-        "fixed_sentence": "на него никто не польстится",
+        "text": "на него никто не польститься",
+        "fixed_text": "на него никто не польстится",
         "label": 0,
         "error_type": "Grammar",
         "domain": "prose"
@@ -151,16 +136,50 @@ A few poetry samples are included in this version:
 Please note that error categories are not always set accurately, so you should not use
 the "error_type" field to train classifiers.
 
+### Uncensoring samples
+
+A number of samples contain text with explicit obscenities:
+
+```
+{
+        "id": 1,
+        "text": "Но не простого - с лёгкой еб@нцой.",
+        "fixed_text": "Но не простого - с лёгкой ебанцой.",
+        "label": 0,
+        "error_type": "Misspelling",
+        "domain": "prose"
+}
+```
 
 ### Statistics
 
 Statistics for test split.
 
 ```
-+--------+---------+---------+-------------+--------------+----------+---------+-------+
-| Domain | Grammar | Unknown | Punctuation | Tokenization | Spelling | Mixture | TOTAL |
-+--------+---------+---------+-------------+--------------+----------+---------+-------+
-| prose  | 185     | 636     | 1407        | 1999         | 1802     | 150     | 6179  |
-| poetry | 1       | 614     | 222         | 172          | 27       | 30      | 1066  |
-+--------+---------+---------+-------------+--------------+----------+---------+-------+
++--------+----------+--------------+----------+-------------+---------+---------+---------+-----------+--------+-------+
+| Domain | Spelling | Tokenization | No error | Punctuation | Unknown | Mixture | Grammar | Semantics | Gender | TOTAL |
++--------+----------+--------------+----------+-------------+---------+---------+---------+-----------+--------+-------+
+| prose  | 2127     | 2111         | 18033    | 1562        | 658     | 178     | 203     | 20        | 1      | 24893 |
+| poetry | 209      | 339          | 693      | 475         | 629     | 153     | 2       | 0         | 0      | 2500  |
++--------+----------+--------------+----------+-------------+---------+---------+---------+-----------+--------+-------+
+```
+
+Statistics on the number of edits required to obtain a corrected version of the text:
+```
++-----------------+-------------------+------------------+
+| Number of edits | Number of samples | Share of samples |
++-----------------+-------------------+------------------+
+| 1               | 5824              | 0.75             |
+| 2               | 1137              | 0.15             |
+| 3               | 348               | 0.04             |
+| 4               | 184               | 0.02             |
+| 5               | 97                | 0.01             |
+| >5              | 183               | 0.02             |
++-----------------+-------------------+------------------+
 ```
+
+## See also
+
+[RuCOLA](https://huggingface.co/datasets/RussianNLP/rucola)  
+[ai-forever/spellcheck_benchmark](https://huggingface.co/datasets/ai-forever/spellcheck_benchmark)  
+