Update README.md

README.md

@@ -1,3 +1,57 @@
----
-license: apache-2.0
----
+---
+license: apache-2.0
+language:
+- ru
+---
+
+### Dataset Summary
+
+This dataset is a set of samples for testing a spell checker.
+I assembled this set by hand from various sources.
+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), You can consider this dataset as an extension of RuCOLA, since the dataset format is made as compatible as possible.
+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": "Разучи стихов побольше",
+        "label": 0,
+        "error_type": "Misspelling"
+}
+```
+
+### Uncensoring samples
+
+A number of samples contain text with explicit obscenities:
+
+```
+{
+        "id": 1,
+        "sentence": "Но не простого - с лёгкой еб@нцой.",
+        "fixed_sentence": "Но не простого - с лёгкой ебанцой.",
+        "label": 0,
+        "error_type": "Misspelling"
+}
+```
+
+
+### 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".  
+**error_type** (str): the violation category, Misspelling, Syntax, Semantics, or Hallucination).  
+
+### Statistics
+
+Current version contains:
+
+Misspelling	- 3222  
+Syntax	- 1954  
+Semantics	- 2  
+