Update README.md

README.md

@@ -3,4 +3,56 @@ language:
 - ru
 library_name: fasttext
 pipeline_tag: text-classification
----
+---
+
+# FastText Классификатор текста
+
+Это модель FastText для классификации текста, обученная на моём новостной датасете data-silence/rus_news_classifier, состоящем из новостей за последние 5 лет, размещенная на Hugging Face Hub.
+
+## Описание модели
+
+Эта модель использует FastText для классификации текста по 11 категориям. Она была обучена на ~ 70_000 примерах и достигает точности 0.8691016964865116 на тестовом наборе данных.
+
+### Задача
+
+Модель предназначена для классификации русскоязычных новостных статей по 11 категориям.
+
+
+### Категории
+
+Модель классифицирует тексты по следующим категориям:
+{
+    0: 'climate', 1: 'conflicts', 2: 'culture', 3: 'economy', 4: 'gloss',
+    5: 'health', 6: 'politics', 7: 'science', 8: 'society', 9: 'sports', 10: 'travel'
+}
+
+## Использование
+
+Чтобы использовать эту модель, вам понадобятся библиотеки `fasttext` и `transformers`. Установите их с помощью pip:
+
+`pip install fasttext transformers`
+
+Пример использования модели:
+
+```python
+from transformers import pipeline
+
+classifier = pipeline("text-classification", model="[ВАШ_ПОЛЬЗОВАТЕЛЬ]/[ИМЯ_РЕПОЗИТОРИЯ]")
+
+text = "Ваш текст для классификации здесь"
+result = classifier(text)
+print(result)
+```
+
+## Контакты
+
+Если у вас есть вопросы или предложения по улучшению модели, пожалуйста, создайте issue в этом репозитории или свяжитесь со мной по адресу [email protected].
+
+@misc{data-silence_fasttext_classifier,
+  author = {Max K},
+  title = {FastText Классификатор текста},
+  year = {2024},
+  publisher = {Hugging Face},
+  journal = {Hugging Face Hub},
+  howpublished = {\url{https://huggingface.co/data-silence/fasttext-rus-news-classifier}}
+}