Syrzyk-Dataset / README.md
vlddshk's picture
Upload folder using huggingface_hub
1e3d0b0 verified
|
Raw
History Blame Contribute Delete
15.5 kB
---
language:
- uk
license: cc-by-4.0
size_categories:
- 1K<n<10K
task_categories:
- translation
task_ids:
- text2text-generation
pretty_name: Syrzyk Dataset
tags:
- surzhyk
- ukrainian
- text-normalization
- parallel-corpus
- parquet
- nlp
- error-correction
- seq2seq
dataset_info:
features:
- name: syrzyk
dtype: string
- name: ukrainian
dtype: string
- name: source
dtype: string
splits:
- name: train
num_bytes: 361508
num_examples: 4357
- name: validation
num_bytes: 49786
num_examples: 545
- name: test
num_bytes: 52417
num_examples: 545
download_size: 463876
dataset_size: 463876
configs:
- config_name: default
data_files:
- split: train
path: train.parquet
- split: validation
path: validation.parquet
- split: test
path: test.parquet
---
# 🇺🇦 SyrzykAI Dataset: Паралельний корпус «Суржик ↔ Літературна українська мова»
<div align="center">
[![License: CC BY 4.0](https://img.shields.io/badge/License-CC_BY_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/)
[![Format: Parquet](https://img.shields.io/badge/Format-Parquet-blue.svg)](https://parquet.apache.org/)
[![Size: 5.4k pairs](https://img.shields.io/badge/Size-5%2C447_pairs-green.svg)](#статистика-сплітів)
[![Domain: NLP / Translation](https://img.shields.io/badge/Task-Text_Normalization_%2F_Seq2Seq-orange.svg)](#призначення-датасету)
</div>
---
## Опис датасету (Dataset Summary)
**Syrzyk Dataset** — це ретельно верифікований паралельний корпус речень для задачі нормалізації тексту, виправлення русизмів та автоматичного виправлення суржику на нормативну літературну українську мову.
Датасет створено в рамках проекту **SyrzykAI** для fine-tuning Seq2Seq моделей (в першу чергу `facebook/nllb-200-distilled-600M`) та оцінки якості систем корекції тексту за допомогою метрик **chrF**, **CER** та **WER**.
Датасет збережений у високоефективному бінарному форматі **Apache Parquet**, очищений від дублікатів і шумів, та розбитий на фіксовані вибірки (**train / validation / test**) із фіксованим `seed=42`.
---
## Структура датасету (Dataset Structure)
### Схема колонок (Features)
| Назва колонки | Тип даних | Опис | Приклад |
| :------------ | :-------- | :--------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------- |
| `syrzyk` | `string` | Вхідне речення/фраза з елементами суржику, калькованими конструкціями чи русизмами | `"Я сьогодня випив кофе, но воно було холодне, потому шо я забув його підігріти."` |
| `ukrainian` | `string` | Нормативний літературний відповідник українською мовою | `"Я сьогодні випив каву, але вона була холодна, бо я забув її підігріти."` |
| `source` | `string` | Джерело походження та метод підготовки пари речень | `"manual"`, `"synthetic"`, `"hplt_v3_modified"` |
### Статистика сплітів (Data Splits)
| Спліт | Кількість пар | Відсоток | Файл | Розмір |
| :--------------- | :-----------: | :------: | :------------------- | :-----: |
| **`train`** | **4,357** | 80.0% | `train.parquet` | ~353 KB |
| **`validation`** | **545** | 10.0% | `validation.parquet` | ~48 KB |
| **`test`** | **545** | 10.0% | `test.parquet` | ~51 KB |
| **Разом** | **5,447** | 100.0% | — | ~453 KB |
Розподіл здійснено за допомогою `train_test_split` бібліотеки Hugging Face `datasets` із перемішуванням (`shuffle=True`) та зафіксованим генератором випадкових чисел (`seed=42`).
---
## Джерела даних та методологія (Dataset Curation)
Датасет сформовано з комбінації трьох взаємодоповнюючих джерел для забезпечення різноманітності лексичних, граматичних та стилістичних форм:
```
┌──────────────────────────────────────────────┐
│ SyrzykAI Dataset (5,447) │
└──────────────────────┬───────────────────────┘
┌────────────────────────────────┼────────────────────────────────┐
│ 42.2% │ 32.4% │ 25.4%
▼ ▼ ▼
┌─────────────────┐ ┌───────────────────┐ ┌───────────────────┐
│ manual │ │ hplt_v3_modified │ │ synthetic │
│ (2,297 пар) │ │ (1,764 пари) │ │ (1389 пари) │
│ Власноруч скла- │ │ Корпус HPLT v3 │ │ Згенеровано Kimi │
│ дені побутові │ │ + правила заміни │ │ K2 + ручна вери- │
│ та розмовні │ │ + ручна фільтрація│ │ фікація / правки │
│ речення │ │ │ │ │
└─────────────────┘ └───────────────────┘ └───────────────────┘
```
1. **`manual` (2,297 пар / 42.2%)**:
- Автентичні розмовні конструкції, записані вручну на основі живого мовлення та типових розмовних конструкцій.
- Охоплює типові сленгові звороти, щоденні діалоги, фразеологічні кальки.
2. **`hplt_v3_modified` (1,764 пари / 32.4%)**:
- Відібрані високоякісні нормативні речення з відкритого веб-корпусу **HPLT v3** ([High-Performance Language Technologies / OPUS](https://opus.nlpl.eu/datasets/HPLT?pair=en&uk)).
- Застосовано лінгвістичний генератор псевдо-суржику (модуль `script_for_dataset.py`) з підстановкою типових русизмів, після чого виконано ручну перевірку та фільтрацію некоректних пар.
3. **`synthetic` (1,386 пар / 25.4%)**:
- Синтетично згенеровані пари за допомогою LLM (Kimi K2) з акцентом на складні синтаксичні русизми, прийменникові конструкції та діловий/публіцистичний суржик.
- **Усі пари пройшли обов'язкову ручну верифікацію та редагування людиною.**
---
## Лінгвістичне покриття
Датасет покриває ключові типи суржикових помилок та інтерференції:
- **Лексичні кальки та русизми**: *привєт* &rarr; *привіт*, *получається* &rarr; *виходить*, *заказ* &rarr; *замовлення*, *канєшно* &rarr; *звісно / звичайно*, *даже* &rarr; *навіть*, *строїти* &rarr; *будувати*, *підписка* &rarr; *передплата*.
- **Фонетичні та графічні спотворення**: чергування голосних (*дєвочка* &rarr; *дівчинка*, *рєчєння* &rarr; *речення*, *всє* &rarr; *всі*).
- **Порушення синтаксичного керування та прийменникові конструкції**:
- *по справах* замість *по ділах*
- *двома словами* замість *в двох словах*
- *на тиждень* замість *на неділю*
- *через хворобу* замість *по хворобі / із-за хвороби*
- **Неправильні дієслівні форми**: *дєлати / робить* &rarr; *робити*, *казав* &rarr; *говорив*.
---
## Як використовувати (Quickstart)
### 1. Завантаження через Hugging Face `datasets`
```python
from datasets import load_dataset
# Завантаження всіх сплітів датасету
dataset = load_dataset("vlddshk/Syrzyk-Dataset")
print(dataset)
# DatasetDict({
# train: Dataset({
# features: ['syrzyk', 'ukrainian', 'source'],
# num_rows: 4357
# }),
# validation: Dataset({
# features: ['syrzyk', 'ukrainian', 'source'],
# num_rows: 545
# }),
# test: Dataset({
# features: ['syrzyk', 'ukrainian', 'source'],
# num_rows: 545
# })
# })
# Приклад перегляду першого запису з train
sample = dataset["train"][0]
print(f"Суржик: {sample['syrzyk']}")
print(f"Українська: {sample['ukrainian']}")
print(f"Джерело: {sample['source']}")
```
### 2. Завантаження окремого спліту або через Pandas
```python
import pandas as pd
# Читання Parquet файлу безпосередньо
df_train = pd.read_parquet("https://huggingface.co/datasets/vlddshk/Syrzyk-Dataset/resolve/main/train.parquet")
print(df_train.head())
```
### 3. Токенізація для Seq2Seq моделей (NLLB-200 / mT5)
```python
from transformers import AutoTokenizer
model_name = "facebook/nllb-200-distilled-600M"
tokenizer = AutoTokenizer.from_pretrained(model_name, src_lang="ukr_Cyrl", tgt_lang="ukr_Cyrl")
def preprocess_function(examples):
inputs = examples["syrzyk"]
targets = examples["ukrainian"]
model_inputs = tokenizer(inputs, text_target=targets, max_length=128, truncation=True)
return model_inputs
tokenized_dataset = dataset.map(preprocess_function, batched=True)
```
---
## Цільові задачі та призначення (Supported Tasks)
- `translation` / `text2text-generation`: переклад із суржику на літературну українську.
- `grammatical-error-correction`: виправлення граматичних, орфографічних і лексичних помилок інтерференції.
- `text-normalization`: нормалізація неформального або змішаного веб-контенту / субтитрів / чат-повідомлень.
---
## ⚠️ Обмеження та особливості (Limitations & Biases)
- **Обсяг вибірки (v2.0)**: Датасет містить 5,447 ретельно відібраних прикладів. Це якісний seed-датасет для fine-tuning та бенчмаркінгу, але для більшого покриття всіх регіональних діалектів планується розширення корпусу до 10k прикладів.
- **Регіональна варіативність**: Суржик не є уніфікованою мовою — у різних регіонах (наприклад, Слобожанщина vs. Полісся vs. Південь) ступінь і характер русизмів відрізняються.
- **Відсутність нецензурної лексики**: Корпус пройшов базову санітизацію та орієнтований на загальновживану, публіцистичну та щоденну розмовну лексику.
---
## Ліцензія (License)
Датасет поширюється за відкритою ліцензією **[Creative Commons Attribution 4.0 International (CC BY 4.0)](https://creativecommons.org/licenses/by/4.0/)**.
Ви можете вільно:
- Ділитися (копіювати і розповсюджувати матеріал на будь-якому носії чи у будь-якому форматі).
- Адаптувати (робити ремікси, трансформувати та брати за основу матеріал для будь-яких цілей, навіть комерційних),
за умови зазначення авторства та збереження посилання на оригінальний репозиторій.
---
## Цитування (Citation)
Якщо ви використовуєте **SyrzykAI Dataset** у своїх наукових дослідженнях, програмних продуктах або статтях, будь ласка, використовуйте наступний BibTeX:
```bibtex
@misc{syrzyk_ai_2026,
title={SyrzykAI: Parallel Surzhyk-to-Ukrainian Dataset for Text Normalization and Neural Machine Translation},
author={vlddshk},
year={2026},
publisher={Hugging Face},
howpublished={\url{https://huggingface.co/datasets/vlddshk/syrzyk-dataset}},
license={CC-BY-4.0}
}
```
---
## Зв'язок та внесок (Contributions)
Бажаєте додати нові пари речень, виправити помилку або запропонувати покращення?
- Відкривайте **Discussions / Pull Requests** на Hugging Face або GitHub!
- Проект розробляється як частина відкритої ініціативи з очищення та підтримки української мови у сфері NLP.
## Version History
- **v2.0 (August 2026)**: Added 1,088 new pairs.
- **v1.0 (August 2026)**: Initial release (4,359 pairs).