Update README.md

README.md

@@ -1,21 +1,34 @@
 ---
 tags:
-- spacy
+- Token Classification
+- spacy 
+- SpanCategorizer
+- grammar_checker 
+- essay_checker 
+
 language:
 - en
 license: cc-by-sa-3.0
-model-index:
-- name: en_grammar_checker
-  results: []
 ---
-| Feature | Description |
-| --- | --- |
-| **Name** | `en_grammar_checker` |
-| **Version** | `1.0.2` |
-| **spaCy** | `>=3.5.0,<3.6.0` |
-| **Default Pipeline** | `punctuation`, `spelling`, `articles`, `grammar_major`, `grammar_minor`, `vocabulary` |
-| **Components** | `punctuation`, `spelling`, `articles`, `grammar_major`, `grammar_minor`, `vocabulary` |
-| **Vectors** | 0 keys, 0 unique vectors (0 dimensions) |
-| **Sources** | n/a |
-| **License** | n/a |
-| **Author** | [n/a]() |
+
+# Essay Grammar Checker
+
+Essay Grammar Checker trained on [Russian Error-Annotated Learner English Corpus](https://realec.org).
+
+## Training information
+The checker consists of 6 pipelines each trained on specific error types.
+Error Categories used for pipeline mapping:  
+
+```
+    "spelling":{"Spelling", "Capitalisation"},  
+    "punctuation": {"Punctuation"},
+    "articles": {"Articles"},  
+    "vocabulary": {"lex_item_choice", "lex_part_choice",
+                   'Category_confusion','Formational_affixes'},
+    "grammar_major": {'Tense_choice','Prepositions','Agreement_errors', 'Redundant_comp'},
+    "grammar_minor": {'Word_order','Noun_number', 'Numerals','Verb_pattern', 'Determiners'}
+``` 
+
+[Detailed information](https://github.com/upunaprosk/grammar_checker)
+
+[Example usage in Colab](https://github.com/upunaprosk/grammar_checker/blob/master/grammar_checker_example_usage.ipynb)