Docs: добавлена документация по структуре модели

README.md

@@ -1,3 +1,132 @@
 ---
+library_name: setfit
+tags:
+- setfit
+- sentence-transformers
+- classification
+- russian
+- voice-commands
+- panda
+- commands
+language: ru
 license: mit
+pipeline_tag: text-classification
 ---
+# CVC-Panda
+
+Модель для классификации голосовых команд на русском языке для управления пандой (CVC-Panda).
+
+## Описание
+
+Эта модель представляет собой SetFit классификатор, обученный для распознавания и классификации голосовых команд на русском языке. Модель использует few-shot learning подход через SetFit, что позволяет эффективно обучаться на небольшом количестве примеров.
+
+## Использование
+
+### Базовое использование
+
+```python
+from setfit import SetFitModel
+
+# Загрузка модели
+model = SetFitModel.from_pretrained("your-username/cvc-panda-commands", token="your_token")
+
+# Классификация команд
+commands = ["равняйся", "отставить", "налево", "направо"]
+predictions = model(commands)
+
+# Получение вероятностей
+probs = model.predict_proba(commands)
+```
+
+### Использование с токеном
+
+Если модель приватная или требует аутентификации:
+
+```python
+from setfit import SetFitModel
+from huggingface_hub import login
+
+# Авторизация
+login(token="your_hf_token")
+
+# Загрузка модели
+model = SetFitModel.from_pretrained("your-username/cvc-panda-commands")
+```
+
+### Пакетная обработка
+
+```python
+from setfit import SetFitModel
+
+model = SetFitModel.from_pretrained("your-username/cvc-panda-commands", token="your_token")
+
+# Обработка списка команд
+commands = [
+    "равняйся",
+    "отставить", 
+    "налево",
+    "направо",
+    "шагом марш"
+]
+
+predictions = model(commands)
+print(predictions)
+```
+
+## Архитектура модели
+
+Модель основана на SetFit и использует архитектуру sentence-transformers:
+
+- **Базовый энкодер**: Предобученная модель для русского языка
+- **Классификатор**: Обученная голова классификатора (SetFit head)
+- **Формат**: SetFit/sentence-transformers совместимый формат
+
+## Обучение
+
+Модель обучена на датасете голосовых команд с использованием SetFit (few-shot learning). Обучение происходит автоматически через CI/CD пайплайн, после чего модель загружается на Hugging Face Hub.
+
+### Параметры обучения
+
+- **Метод**: SetFit (few-shot learning)
+- **Язык**: Русский (ru)
+- **Тип задачи**: Многоклассовая классификация
+
+## Структура модели
+
+Модель сохраняется в формате sentence-transformers и содержит:
+
+- `config.json` - Основная конфигурация модели
+- `config_setfit.json` - Конфигурация SetFit
+- `config_sentence_transformers.json` - Конфигурация sentence-transformers
+- `model_head.pkl` - Обученная голова классификатора
+- `model.safetensors` - Веса модели
+- `tokenizer.json` - Токенизатор
+- Модули: `1_Pooling/`, `2_Dense/`, `3_Dense/`, `4_Normalize/`
+
+## Версионирование
+
+Модель автоматически версионируется через Git при каждой загрузке через CI/CD. Вы можете:
+
+- Просматривать историю версий на вкладке "Files and versions"
+- Использовать конкретную версию через commit hash
+- Тегировать стабильные версии для production
+
+## Требования
+
+```python
+setfit>=0.7.0
+sentence-transformers>=2.2.0
+transformers>=4.21.0
+```
+
+## Лицензия
+
+MIT License
+
+## Автор
+
+ShiWarai
+
+---
+
+**Примечание**: Для приватных моделей убедитесь, что токен `HF_TOKEN` установлен на production-сервере.