Update README.md

README.md

@@ -1,76 +1,48 @@
 ---
+license: mit
+language:
+- ru
 library_name: transformers
-base_model: ai-forever/ruBert-large
+pipeline_tag: token-classification
 tags:
-- generated_from_trainer
-metrics:
-- precision
-- recall
-- f1
-model-index:
-- name: my-chgk-ner-model-v1
-  results: []
+- ner
+- ru
+- chgk
+base_model:
+- ai-forever/ruBert-large
 ---
 
-<!-- This model card has been generated automatically according to the information the Trainer had access to. You
-should probably proofread and complete it, then remove this comment. -->
+# NER-модель для извлечения сущностей из текстов "Что? Где? Когда?"
 
-# my-chgk-ner-model-v1
+Это модель для **распознавания именованных сущностей (NER)**, дообученная на базе `ai-forever/ruBert-large`. Модель была создана в рамках пет-проекта для анализа текстов вопросов игры "Что? Где? Когда?".
 
-This model is a fine-tuned version of [ai-forever/ruBert-large](https://huggingface.co/ai-forever/ruBert-large) on an unknown dataset.
-It achieves the following results on the evaluation set:
-- Loss: 0.3204
-- Precision: 0.6308
-- Recall: 0.6464
-- F1: 0.6347
+## 🚀 Интерактивное демо
 
-## Model description
+Вы можете протестировать эту модель в действии в интерактивном веб-приложении на **Hugging Face Spaces**:
 
-More information needed
+**[➡️ Перейти к демо ⬅️](httpss://huggingface.co/spaces/YourUsername/chgk-ner-demo)** 
+*(<-- Замените `YourUsername/chgk-ner-demo` на ссылку на ваш Space)*
 
-## Intended uses & limitations
+## 🏷️ Извлекаемые сущности
 
-More information needed
+Модель обучена распознавать 5 типов сущностей:
 
-## Training and evaluation data
+*   `AUTHOR`: Авторы (писатели, художники, композиторы и т.д.)
+*   `CHARACTER`: Персонажи (литературные, вымышленные)
+*   `LOCATION`: Локации (города, страны, географические объекты)
+*   `PERSON`: Персоналии (реальные исторические личности, ученые, политики)
+*   `WORK_OF_ART`: Произведения искусства (книги, картины, фильмы и т.д.)
 
-More information needed
+## 📊 Качество модели
 
-## Training procedure
+Модель была оценена на тестовом наборе данных. Ниже представлены итоговые метрики F1-score для каждого класса.
 
-### Training hyperparameters
+| Категория     | F1-score |
+|---------------|----------|
+| **AUTHOR**    | **0.826**|
+| **LOCATION**  | **0.825**|
+| **WORK_OF_ART**| **0.810**|
+| **CHARACTER** | **0.672**|
+| **PERSON**    | **0.625**|
 
-The following hyperparameters were used during training:
-- learning_rate: 2e-05
-- train_batch_size: 32
-- eval_batch_size: 16
-- seed: 42
-- optimizer: Use OptimizerNames.ADAMW_TORCH with betas=(0.9,0.999) and epsilon=1e-08 and optimizer_args=No additional optimizer arguments
-- lr_scheduler_type: linear
-- num_epochs: 25
-- mixed_precision_training: Native AMP
-
-### Training results
-
-| Training Loss | Epoch | Step | Validation Loss | Precision | Recall | F1     |
-|:-------------:|:-----:|:----:|:---------------:|:---------:|:------:|:------:|
-| No log        | 1.0   | 50   | 0.2016          | 0.3892    | 0.4330 | 0.3974 |
-| No log        | 2.0   | 100  | 0.1674          | 0.4990    | 0.5723 | 0.5258 |
-| No log        | 3.0   | 150  | 0.1732          | 0.5184    | 0.6257 | 0.5621 |
-| No log        | 4.0   | 200  | 0.1819          | 0.5821    | 0.6373 | 0.6079 |
-| No log        | 5.0   | 250  | 0.2041          | 0.6160    | 0.6317 | 0.6208 |
-| No log        | 6.0   | 300  | 0.2197          | 0.6023    | 0.6908 | 0.6411 |
-| No log        | 7.0   | 350  | 0.2349          | 0.6100    | 0.6512 | 0.6281 |
-| No log        | 8.0   | 400  | 0.2418          | 0.6039    | 0.6490 | 0.6240 |
-| No log        | 9.0   | 450  | 0.2609          | 0.6456    | 0.6744 | 0.6575 |
-| 0.0914        | 10.0  | 500  | 0.2792          | 0.6243    | 0.6658 | 0.6396 |
-| 0.0914        | 11.0  | 550  | 0.2931          | 0.6375    | 0.6693 | 0.6515 |
-| 0.0914        | 12.0  | 600  | 0.3204          | 0.6308    | 0.6464 | 0.6347 |
-
-
-### Framework versions
-
-- Transformers 4.52.4
-- Pytorch 2.6.0+cu124
-- Datasets 3.6.0
-- Tokenizers 0.21.2
+Модель демонстрирует высокую надежность для классов `AUTHOR`, `LOCATION` и `WORK_OF_ART`. Классы `PERSON` и `CHARACTER` оказались более сложными из-за семантической близости, что отражено в их метриках.