Create README.md

README.md

@@ -0,0 +1,25 @@
+---
+language:
+- uk
+tags:
+- ukrainian
+widget:
+ - text: "упродовж 2012-2014 років національний природний парк «зачарований край» разом із всесвітнім фондом природи wwf успішно реалізували проект із відновлення болота «чорне багно» розташованого на схилах гори бужора у закарпатті водноболотне угіддя «чорне багно» є найбільшою болотною екосистемою регіону воно займає площу близько 15 га унікальністю цього високогірного болота розташованого на висоті 840 м над рівнем моря є велика потужність торфових покладів (глибиною до 59 м) і своєрідна рослинність у 50-х і на початку 60-х років минулого століття на природних потічках що протікали через болото побудували осушувальні канали це порушило природну рівновагу відтак змінилася екосистема болота"
+license: mit
+---
+## Model Description
+Fine-tuning of [XLM-RoBERTa-Uk](https://huggingface.co/ukr-models/xlm-roberta-base-uk) model on Ukrainian texts to recover punctuation and case.
+
+## How to Use
+
+Download script get_predictions.py from the repository.
+```py
+from transformers import AutoTokenizer, AutoModelForTokenClassification
+from get_predictions import recover_text
+
+tokenizer = AutoTokenizer.from_pretrained('ukr-models/uk-punctcase')
+model = AutoModelForTokenClassification.from_pretrained('ukr-models/uk-punctcase')
+
+text = "..."
+recover_text(text_processed, model, tokenizer)
+```