Update README.md

README.md

@@ -52,15 +52,50 @@ It achieves the following results on the evaluation set:
 
 ## Model description
 
-More information needed
+This model is a coarse-part-of-speech tagger for the Polish language based on sdadas/polish-roberta-base-v2.
+It support 13 classes representing coarse part of speech):
+```
+{
+ 0: 'A',
+ 1: 'Adv',
+ 2: 'Comp',
+ 3: 'Conj',
+ 4: 'Dig',
+ 5: 'Interj',
+ 6: 'N',
+ 7: 'Num',
+ 8: 'Part',
+ 9: 'Prep',
+ 10: 'Punct',
+ 11: 'V',
+ 12: 'X'
+}
+```
+Tags meaning is the same as in nkjp1m dataset:
+
+| Tag   | Description in English           | Description in Polish       | Example in Polish         |
+|-------|----------------------------------|-----------------------------|---------------------------|
+| A     | Adjective                        | przymiotnik                 | szybki                    |
+| Adv   | Adverb                           | przysłówek                  | szybko                    |
+| Comp  | Comparative / Complementizer     | stopień porównawczy / spójnik podrzędny | lepszy / że               |
+| Conj  | Conjunction                      | spójnik                     | i                         |
+| Dig   | Digit                            | cyfra                       | 5, 3                      |
+| Interj| Interjection                     | wykrzyknik                  | och!                      |
+| N     | Noun                             | rzeczownik                  | dom                       |
+| Num   | Numeral                          | liczebnik                   | jeden                     |
+| Part  | Particle                         | partykuła                   | by                        |
+| Prep  | Preposition                      | przyimek                    | w                         |
+| Punct | Punctuation                      | interpunkcja                | ., !, ?                   |
+| V     | Verb                             | czasownik                   | biegać                    |
+| X     | Unknown / Other                  | niesklasyfikowane           | xxx                       |
 
 ## Intended uses & limitations
 
-More information needed
+Even though we have some nice tools for pos-tagging in polish (http://morfeusz.sgjp.pl/), I needed a pos tagger for polish that could be easily loaded inside the browser. Huggingface supports such functionality and that's why I created this model.
 
 ## Training and evaluation data
 
-More information needed
+Model was trained on a half of test data of the nkjp1m dataset (~0.5 milion tokens).
 
 ## Training procedure