spell-correction-ru / README.md
melsmm's picture
Update README.md
403eb95 verified
---
license: apache-2.0
language:
- ru
task_categories:
- text-generation
tags:
- spell-correction
- spelling-correction
- punctuation-restoration
- grammatical-error-correction
- russian
size_categories:
- 100K<n<1M
configs:
- config_name: synth_1m
data_files: synth_spell_correction_1m.csv
default: true
- config_name: ready_30k
data_files: spell_correction_30k.csv
---
# Spell Correction RU — датасеты для коррекции ошибок в русском тексте
Набор данных для обучения моделей **исправления орфографических, пунктуационных и регистровых ошибок** в русскоязычных текстах.
Каждый пример — пара «правильный текст» → «текст с ошибкой». Датасет использовался для обучения модели [`melsmm/Spell-Corrector-RU-4B`](https://huggingface.co/melsmm/Spell-Corrector-RU-4B).
📦 **Код генерации, ноутбуки и полное описание проекта:** [github.com/melsmm/llm-spell-corrector](https://github.com/melsmm/llm-spell-corrector)
## Состав
Датасет содержит **две конфигурации (сабсета):**
| Файл | Config | Примеров | Назначение |
| --- | --- | --: | --- |
| `synth_spell_correction_1m.csv` | `synth_1m` | ~1 000 000 | Синтетически сгенерированные ошибки. Для основного обучения (Stage 1). |
| `spell_correction_30k.csv` | `ready_30k` | ~30 800 | Готовые пары «ошибка → исправление» из открытых датасетов. Для финального дообучения (Stage 2). |
## Структура данных
Оба файла имеют одинаковые колонки:
| Колонка | Тип | Описание |
| --- | --- | --- |
| `text` | string | Эталонный (правильный) текст — **target**. |
| `text_corrupt` | string | Текст с ошибками — **input** модели. |
| `source` | string | Источник исходного текста (`nerus`, `gazeta`, `wikipedia`, `RUSpellRU`, `MultidomainGold`, `russian_gec_dataset`, `mixed_raw` и др.). |
| `method` | string | Способ внесения ошибки (`ready_pair`, `sbsc`, `char_aug`, `word_aug`, `punct_corruption`, `lowercase`, `identity`, `mixed_*`). |
Пример строки:
```
text: Об этом сообщает корреспондент «Ленты.ру».
text_corrupt: об этом сообщаеп корреспондент лертыру.
source: mixed_raw
method: mixed_lower_char_punct
```
## Как создавался
### `synth_1m` — синтетический датасет (~1 млн)
Чистые тексты из корпусов `nerus`, `gazeta`, `wikipedia` портились набором алгоритмов: статистическим ([SAGE](https://github.com/ai-forever/sage): `SBSC`, `CharAug`, `WordAug`) и собственным алгоритмом внесения пунктуационных ошибок. Часть примеров оставлена без изменений (`identity`), чтобы модель не «переисправляла» корректный текст.
| Категория | Источник | Алгоритм | Примеров |
| --- | --- | --- | --: |
| Готовые пары | russian_gec_dataset | — | ~25 000 |
| Готовые пары | RUSpellRU | — | ~2 000 |
| Готовые пары | MultidomainGold | — | ~3 569 |
| Чистые (без изменений) | gazeta / wikipedia / nerus | identity | ~50 000 |
| SBSC (статистическая порча) | nerus | SBSCCorruptor | ~200 000 |
| CharAug | nerus / wikipedia | CharAugCorruptor | ~150 000 |
| WordAug | nerus / gazeta | WordAugCorruptor | ~100 000 |
| Punctuation corruption | nerus / wikipedia / gazeta | custom | ~150 000 |
| Lowercase | nerus / gazeta | lowercase | ~100 000 |
| Mixed (2–3 алгоритма) | nerus | multi-corrupt | ~219 431 |
| **ИТОГО** | | | **~1 000 000** |
### `ready_30k` — готовые пары (~30 тыс.)
Объединение реальных пар «ошибка → исправление» из открытых датасетов:
| Источник | Примеров |
| --- | --: |
| russian_gec_dataset | ~25 000 |
| RUSpellRU | ~2 000 |
| MultidomainGold | ~3 569 |
| **ИТОГО** | **~30 569** |
## Загрузка
```python
from datasets import load_dataset
# Синтетический датасет (~1 млн)
synth = load_dataset("melsmm/spell-correction-ru", "synth_1m", split="train")
# Готовые пары (~30 тыс.)
ready = load_dataset("melsmm/spell-correction-ru", "ready_30k", split="train")
print(synth[0])
# {'text': '...', 'text_corrupt': '...', 'source': '...', 'method': '...'}
```
## Назначение и применение
- Обучение моделей spell / punctuation correction для русского языка.
- Двухстадийное обучение: сначала на большом синтетическом наборе (`synth_1m`), затем дообучение на качественных готовых парах (`ready_30k`).
- Аугментация данных для GEC-задач.
Подача в модель: `text_corrupt` как вход, `text` как целевой ответ.
## Источники и лицензии
Датасет собран на основе открытых корпусов и датасетов:
- [nerus](https://github.com/natasha/nerus) (новости Lenta.ru)
- [IlyaGusev/gazeta](https://huggingface.co/datasets/IlyaGusev/gazeta)
- [misterkirill/ru-wikipedia](https://huggingface.co/datasets/misterkirill/ru-wikipedia)
- RUSpellRU, MultidomainGold (через [SAGE](https://github.com/ai-forever/sage))
- [russian_gec_dataset](https://huggingface.co/datasets/dreuxx26/russian_gec)
При использовании учитывайте лицензии исходных корпусов.
## Ограничения
- Большая часть `synth_1m`**синтетические** ошибки; их распределение может отличаться от реальных опечаток пользователей.
- Тексты в основном из новостного, энциклопедического и общего доменов; узкоспециализированные домены (например, медицина) представлены слабо.
## Ссылки
- 🔗 **Проект на GitHub:** https://github.com/melsmm/llm-spell-corrector
- 🤖 **Обученная модель:** https://huggingface.co/melsmm/Spell-Corrector-RU-4B