Upload folder using huggingface_hub

README.md

@@ -1,24 +1,44 @@
 # Braindler Final Model v2
 
-Модель fine-tuned на датасетах:
+🎓 **Образовательный AI-ассистент для изучения русского языка**
 
-## Датасеты
+Модель fine-tuned на образовательных датасетах для помощи детям и взрослым в изучении русского языка.
+
+## 📦 Доступные форматы
+
+### HuggingFace (PyTorch)
+Стандартный формат для использования с Transformers (501 MB)
+
+### GGUF (llama.cpp / Ollama)
+Оптимизированные квантизированные версии для локального запуска:
+
+| Версия | Размер | Качество | Рекомендация |
+|--------|--------|----------|--------------|
+| Q2_K | 68 MB | Минимальное | Слабые устройства 📱 |
+| Q3_K_S | 73 MB | Низкое | Мобильные 💻 |
+| Q4_K_S | 84 MB | Среднее | Баланс ⚖️ |
+| **Q4_K_M** | **90 MB** | **Хорошее** | ⭐ **РЕКОМЕНДУЕТСЯ** |
+| Q5_K_M | 99 MB | Высокое | Продакшн 💎 |
+| Q8_0 | 133 MB | Отличное | Максимум 🏆 |
+| F16 | 244 MB | Без потерь | GPU 🎯 |
+
+## 📚 Датасеты для обучения
 
 1. **mozgach_trener** (97 примеров)
-   - Образовательный контент на русском
-   - Алфавит, цифры, цвета, фигуры
-   
-2. **alice_gift** (175 примеров)  
-   - Дополнительные текстовые данные
+   - Алфавит (66 примеров)
+   - Цифры (11 примеров)
+   - Цвета (10 примеров)
+   - Геометрические фигуры (5 примеров)
+   - Голосовые команды (5 примеров)
 
-## Статистика обучения
+2. **alice_gift** (66 примеров)
+   - Дополнительные текстовые данные на русском
 
-- Всего примеров: 163
-- Эпох: 3
-- Базовая модель: nativemind/braindler_full_trained_model
-- Дата: 2025-10-20
+**Всего примеров: 163 | Эпох: 3**
 
-## Использование
+## 🚀 Использование
+
+### С Transformers (PyTorch)
 
 ```python
 from transformers import AutoModelForCausalLM, AutoTokenizer
@@ -28,15 +48,97 @@ tokenizer = AutoTokenizer.from_pretrained("nativemind/braindler_final_model")
 
 prompt = "User: Как произносится буква А?\nAssistant:"
 inputs = tokenizer(prompt, return_tensors="pt")
-outputs = model.generate(**inputs, max_length=200)
+outputs = model.generate(**inputs, max_length=200, temperature=0.7)
 print(tokenizer.decode(outputs[0]))
 ```
 
-## Контакты
+### С Ollama (GGUF) ⭐ Рекомендуется
+
+```bash
+# 1. Скачайте GGUF файл
+huggingface-cli download nativemind/braindler_final_model \
+  braindler_final_model_Q4_K_M.gguf --local-dir ./
+
+# 2. Создайте Modelfile
+cat > Modelfile << 'EOF'
+FROM ./braindler_final_model_Q4_K_M.gguf
+TEMPLATE """{{- if .System }}System: {{ .System }}{{- end }}
+User: {{ .Prompt }}
+Assistant:"""
+PARAMETER temperature 0.7
+PARAMETER top_p 0.9
+PARAMETER num_ctx 2048
+SYSTEM """Ты - Braindler, образовательный ассистент для изучения русского языка. Помогаешь учить буквы, цифры, цвета и слова. Отвечай дружелюбно и понятно."""
+EOF
+
+# 3. Создайте модель
+ollama create braindler -f Modelfile
+
+# 4. Запустите
+ollama run braindler
+```
+
+### С llama.cpp
+
+```bash
+# Скачайте GGUF файл и запустите
+./llama-cli \
+  -m braindler_final_model_Q4_K_M.gguf \
+  -p "User: Расскажи о букве А\nAssistant:" \
+  -n 128 --temp 0.7 -ngl 99
+```
+
+## 📖 Примеры
+
+```
+User: Как произносится буква А?
+Assistant: Буква 'А' произносится как 'а'. Попробуй произнести её вслух: а.
+
+User: Назови слова на букву Б
+Assistant: Слова на букву 'б': банан, бабочка, барабан, белка
+
+User: Что такое треугольник?
+Assistant: Треугольник - это фигура с 3 сторонами и 3 углами. Похож на крышу дома.
+```
+
+## 📊 Характеристики модели
+
+- Базовая модель: nativemind/braindler_full_trained_model
+- Архитектура: GPT-2 (125M параметров)
+- Язык: Русский 🇷🇺
+- Контекст: 2048 токенов
+- Задача: Text Generation, Образовательный ассистент
+- Лицензия: NativeMindNONC (Non-Commercial)
+
+## 🎯 Применение
+
+- Образовательные приложения для детей
+- Обучение рус��кому языку
+- Интерактивные образовательные боты
+- Голосовые ассистенты
+- Локальные AI приложения
+
+## ⚙️ Рекомендации по выбору версии
+
+- **Мобильные устройства**: Q2_K или Q3_K_S
+- **Десктопы/ноутбуки**: Q4_K_M ⭐ (лучший баланс)
+- **Продакшн**: Q5_K_M
+- **Максимальное качество**: Q8_0 или F16
+
+## 🔗 Ссылки
+
+- **Model**: https://huggingface.co/nativemind/braindler_final_model
+- **Dataset 1**: https://huggingface.co/datasets/nativemind/mozgach_trener
+- **Dataset 2**: https://huggingface.co/datasets/nativemind/mozgach_alice_gift
+
+## 📧 Контакты
 
 - Email: anton.v.dodonov@gmail.com
 - HuggingFace: nativemind
+- Дата: 2025-10-20
 
 ---
 
-© 2025 NativeMind. NativeMindNONC License (Non-Commercial)
+© 2025 NativeMind. Для некоммерческого использования.
+
+**Образование должно быть доступным!** 🎓

README_GGUF.md

@@ -0,0 +1,149 @@
+# Braindler Final Model - GGUF Versions
+
+Высококачественные квантизированные версии модели Braindler для использования с **llama.cpp**, **Ollama**, **LM Studio** и другими.
+
+## 📦 Доступные версии
+
+| Квантизация | Размер | Качество | Рекомендация |
+|-------------|--------|----------|--------------|
+| **Q2_K** | 68 MB | Минимальное | Для ограниченных устройств 📱 |
+| **Q3_K_S** | 73 MB | Низкое | Для слабых устройств 💻 |
+| **Q4_K_S** | 84 MB | Среднее | Хороший баланс ⚖️ |
+| **Q4_K_M** | 90 MB | Хорошее | ⭐ **РЕКОМЕНДУЕТСЯ** для большинства |
+| **Q5_K_M** | 99 MB | Высокое | Отличное качество 💎 |
+| **Q8_0** | 133 MB | Отличное | Почти без потерь 🏆 |
+| **F16** | 244 MB | Без потерь | Для GPU/референса 🎯 |
+
+## 🚀 Использование с Ollama
+
+### 1. Создайте Modelfile
+
+```dockerfile
+FROM ./braindler_final_model_Q4_K_M.gguf
+
+TEMPLATE """{{- if .System }}
+System: {{ .System }}
+{{- end }}
+User: {{ .Prompt }}
+Assistant:"""
+
+PARAMETER temperature 0.7
+PARAMETER top_p 0.9
+PARAMETER top_k 40
+PARAMETER num_ctx 2048
+
+SYSTEM """Ты - Braindler, образовательный ассистент для детей и взрослых, изучающих русский язык. Помогаешь учить буквы, цифры, цвета и слова. Отвечай дружелюбно и понятно."""
+```
+
+### 2. Создайте модель в Ollama
+
+```bash
+ollama create braindler -f Modelfile
+```
+
+### 3. Запустите модель
+
+```bash
+ollama run braindler
+```
+
+```bash
+>>> Как произносится буква А?
+Буква 'А' произносится как 'а'. Попробуй произнести её вслух: а.
+
+>>> Назови слова на букву Б
+Слова на букву 'б': банан, бабочка, барабан, белка
+```
+
+## 🔧 Использование с llama.cpp
+
+```bash
+# Запуск интерактивного чата
+./llama.cpp/build/bin/llama-cli \
+  -m braindler_final_model_Q4_K_M.gguf \
+  -p "User: Как произносится буква А?\nAssistant:" \
+  -n 128 \
+  --temp 0.7 \
+  --top-p 0.9
+
+# Использование с GPU Metal (Apple Silicon)
+./llama.cpp/build/bin/llama-cli \
+  -m braindler_final_model_Q4_K_M.gguf \
+  -ngl 99 \
+  -p "User: Расскажи о цифре 5\nAssistant:"
+```
+
+## 💻 Использование с LM Studio
+
+1. Скачайте любую GGUF версию
+2. Откройте LM Studio
+3. Перетащите файл `.gguf` в окно
+4. Загрузите модель и начните чат
+
+## 📊 Характеристики модели
+
+- **Архитектура**: GPT-2 (125M параметров)
+- **Базовая модель**: nativemind/braindler_full_trained_model
+- **Датасеты для fine-tuning**:
+  - mozgach_trener (97 примеров) - алфавит, цифры, цвета, фигуры
+  - alice_gift (66 примеров) - дополнительные текстовые данные
+- **Язык**: Русский 🇷🇺
+- **Контекст**: 2048 токенов
+- **Лицензия**: NativeMindNONC (Non-Commercial)
+
+## 🎯 Применение
+
+- Образовательные приложения для детей
+- Обучение русскому языку
+- Интерактивные образовательные чат-боты
+- Голосовые ассистенты
+- Локальные AI приложения без интернета
+
+## 📖 Примеры промптов
+
+```
+User: Как правильно произнести букву 'А'?
+Assistant: Буква 'А' произносится как 'а'. Попробуй произнести её вслух: а.
+
+User: Назови слова на букву Б
+Assistant: Слова на букву 'б': банан, бабочка, барабан, белка
+
+User: Расскажи о цвете красный
+Assistant: Цвет 'красный' - это один из основных цветов. Это цвет яблока, помидора и клубники. Яркий и теплый цвет.
+
+User: Что такое треугольник?
+Assistant: Треугольник - это фигура с 3 сторонами и 3 углами. Похож на крышу дома или пирамиду.
+```
+
+## ⚙️ Рекомендации по выбору версии
+
+### Для мобильных/слабых устройств
+→ **Q2_K** или **Q3_K_S** (68-73 MB)
+
+### Для десктопов/ноутбуков  
+→ **Q4_K_M** (90 MB) ⭐ лучший баланс
+
+### Для производствен��ого использования
+→ **Q5_K_M** (99 MB) высокое качество
+
+### Для максимального качества
+→ **Q8_0** (133 MB) или **F16** (244 MB)
+
+## 🔗 Ссылки
+
+- **HuggingFace Model**: https://huggingface.co/nativemind/braindler_final_model
+- **Dataset 1**: https://huggingface.co/datasets/nativemind/mozgach_trener
+- **Dataset 2**: https://huggingface.co/datasets/nativemind/mozgach_alice_gift
+
+## 📧 Контакты
+
+- **Email**: anton.v.dodonov@gmail.com
+- **HuggingFace**: nativemind
+- **Дата**: 2025-10-20
+
+---
+
+© 2025 NativeMind. Для некоммерческого использования.
+
+**Образование должно быть доступным!** 🎓
+