Update README.md

README.md

@@ -10,4 +10,43 @@ base_model:
 - ai-forever/ruT5-base
 pipeline_tag: question-answering
 library_name: transformers
----
+---
+
+# Сохранение содержимого README.md без части с Telegram-ботом
+
+readme_content = """
+# Проект: Чат-бот с использованием модели ruT5-base для ответов на вопросы
+
+## Описание
+Этот проект представляет собой систему, которая использует предобученную модель **ruT5-base** для генерации ответов на вопросы, основанных на предоставленном контексте. Мы дообучаем модель на датасете SberQUAD, адаптируя её для задач вопросно-ответного взаимодействия на русском языке.
+
+## Датасет
+Мы используем датасет [SberQUAD](https://huggingface.co/datasets/kuznetsoffandrey/sberquad), который содержит примеры вопросов и ответов на них в контексте различных текстов. Датасет разбит на тренировочные, валидационные и тестовые части.
+
+## Архитектура модели
+В качестве базовой модели используется [ruT5-base](https://huggingface.co/ai-forever/ruT5-base) — Encoder-Decoder модель, оптимизированная для задач на русском языке. Модель была дополнительно дообучена на кастомных данных для улучшения генерации ответов на основе предоставленного контекста.
+
+## Параметры обучения
+
+Для обучения использовались следующие параметры:
+
+```python
+output_dir="./models",
+optim="adafactor",
+num_train_epochs=1, # в идеале 2 эпохи
+do_train=True,
+gradient_checkpointing=True,
+bf16=True,
+per_device_train_batch_size=8,
+per_device_eval_batch_size=12,
+gradient_accumulation_steps=4,
+logging_dir="./logs",
+report_to="wandb",
+logging_steps=10,
+save_strategy="steps",
+save_steps=5000,
+evaluation_strategy="steps",
+eval_steps=300,
+learning_rate=3e-5,
+predict_with_generate=False,
+generation_max_length=64