Create README.md

README.md

@@ -0,0 +1,32 @@
+---
+language: lt
+tags:
+- byt5
+- Lithuanian
+- grammatical error correction
+widget:
+- text: 'Sveiki pardodu tvarkyngą "Audi" firmos automobylį. Kątik iš Amerikės. Viena savininka prižiurietas ir mylietas Automobylis. Dar turu patobulintą „Mersedes“ su automatinia greičių pavara už 4000 evrų (iš Amerikės). Taippat tvarkingas.'
+
+license: apache-2.0
+---
+This is *google/byt5-small* transformer model trained on Lithuanian text for ~100 hours.
+It was created during the work **Towards Lithuanian Grammatical Error Correction**, which will be presented at [11th Computer Science On-line Conference 2022](https://csoc.openpublish.eu/).
+
+The model is yet in its infancy (we are planning to train 100x longer in the future). Nevertheless, it clearly shows the possibilities and capabilities.
+
+## Usage
+Given the following corrupted text obtained from [https://www.diktantas.lt/pasitikrink-lietuviu-kalbos-zinias]:
+```
+text = 'Sveiki pardodu tvarkyngą "Audi" firmos automobylį. Kątik iš Amerikės. Viena savininka prižiurietas ir mylietas Automobylis. Dar turu patobulintą „Mersedes“ su automatinia greičių pavara už 4000 evrų (iš Amerikės). Taippat tvarkingas.'
+```
+The correction can be obtained by:
+```python
+from transformers import pipeline
+name= "LukasStankevicius/ByT5-Lithuanian-gec-100h"
+my_pipeline = pipeline(task="text2text-generation", model=name, framework="pt")
+corrected_text = my_pipeline(text)[0]["generated_text"]
+print(corrected_text)
+```
+Output from above would be:
+
+Sveiki parduodu tvarkingą „Audi“ firmos automobilį. Ką tik iš Amerikės. Viena savininkas prižiūrintas ir mylimas automobilis. Dar turiu patobulintą „Mersedes“ su automatine greičių pavara už 4000 eurų (iš Amerikės). Taip pat tvarkingas.