Upload folder using huggingface_hub

README.md

@@ -1,3 +1,258 @@
 ---
+language:
+- uk
 license: cc-by-4.0
+size_categories:
+- 1K<n<10K
+task_categories:
+- translation
+- text2text-generation
+task_ids:
+- grammatical-error-correction
+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: 305507
+    num_examples: 3487
+  - name: validation
+    num_bytes: 42804
+    num_examples: 436
+  - name: test
+    num_bytes: 42157
+    num_examples: 436
+  download_size: 390468
+  dataset_size: 390468
+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: 4.3k pairs](https://img.shields.io/badge/Size-4%2C359_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`**      |   **3,487**   |  80.0%   | `train.parquet`      | ~305 KB |
+| **`validation`** |    **436**    |  10.0%   | `validation.parquet` | ~43 KB  |
+| **`test`**       |    **436**    |  10.0%   | `test.parquet`       | ~42 KB  |
+| **Разом**        |   **4,359**   |  100.0%  | —                    | ~390 KB |
+
+Розподіл здійснено за допомогою `train_test_split` бібліотеки Hugging Face `datasets` із перемішуванням (`shuffle=True`) та зафіксованим генератором випадкових чисел (`seed=42`).
+
+---
+
+## Джерела даних та методологія (Dataset Curation)
+
+Датасет сформован�� з комбінації трьох взаємодоповнюючих джерел для забезпечення різноманітності лексичних, граматичних та стилістичних форм:
+
+```
+                  ┌──────────────────────────────────────────────┐
+                  │          SyrzykAI Dataset (4,359)            │
+                  └──────────────────────┬───────────────────────┘
+                                         │
+        ┌────────────────────────────────┼────────────────────────────────┐
+        │ 43.0%                          │ 34.5%                          │ 22.5%
+        ▼                                ▼                                ▼
+┌─────────────────┐            ┌───────────────────┐            ┌───────────────────┐
+│     manual      │            │ hplt_v3_modified  │            │     synthetic     │
+│   (1,873 пар)   │            │    (1,503 пари)   │            │     (983 пари)    │
+│ Власноруч скла- │            │ Корпус HPLT v3    │            │ Згенеровано Kimi  │
+│ дені побутові   │            │ + правила заміни  │            │ K2 + ручна вери-  │
+│ та розмовні     │            │ + ручна фільтрація│            │ фікація / правки  │
+│ речення         │            │                   │            │                   │
+└─────────────────┘            └───────────────────┘            └───────────────────┘
+```
+
+1. **`manual` (1,873 пари / 43.0%)**:
+   - Автентичні розмовні конструкції, записані вручну на основі живого мовлення та типових розмовних конструкцій.
+   - Охоплює типові сленгові звороти, щоденні діалоги, фразеологічні кальки.
+2. **`hplt_v3_modified` (1,503 пари / 34.5%)**:
+   - Відібрані високоякісні нормативні речення з відкритого веб-корпусу **HPLT v3** ([High-Performance Language Technologies / OPUS](https://opus.nlpl.eu/datasets/HPLT?pair=en&uk)).
+   - Застосовано лінгвістичний генератор псевдо-суржику (модуль `script_for_dataset.py`) з підстановкою типових русизмів, після чого виконано ручну перевірку та фільтрацію некоректних пар.
+3. **`synthetic` (983 пари / 22.5%)**:
+   - Синтетично згенеровані пари за допомогою LLM (Kimi K2) з акцентом на складні синтаксичні русизми, прийменникові конструкції та діловий/публіцистичний суржик.
+   - **Усі пари пройшли обов'язкову ручну верифікацію та редагування людиною.**
+
+---
+
+## Лінгвістичне покриття
+
+Датасет покриває ключові типи суржикових помилок та інтерференції:
+
+- **Лексичні кальки та русизми**: *привєт* $\rightarrow$ *привіт*, *получається* $\rightarrow$ *виходить*, *заказ* $\rightarrow$ *замовлення*, *канєшно* $\rightarrow$ *звісно / звичайно*, *даже* $\rightarrow$ *навіть*, *строїти* $\rightarrow$ *будувати*, *підписка* $\rightarrow$ *передплата*.
+- **Фонетичні та графічні спотворення**: чергування голосних (*дєвочка* $\rightarrow$ *дівчинка*, *рєчєння* $\rightarrow$ *речення*, *всє* $\rightarrow$ *всі*).
+- **Порушення синтаксичного керування та прийменникові конструкції**:
+  - *по справах* замість *по ділах*
+  - *двома словами* замість *в двох словах*
+  - *на тиждень* замість *на неділю*
+  - *через хворобу* замість *по хворобі / із-за хвороби*
+- **Неправильні дієслівні форми**: *дєлати / робить* $\rightarrow$ *робити*, *казав* $\rightarrow$ *говорив*.
+
+---
+
+## 🚀 Як використовувати (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: 3487
+#     }),
+#     validation: Dataset({
+#         features: ['syrzyk', 'ukrainian', 'source'],
+#         num_rows: 436
+#     }),
+#     test: Dataset({
+#         features: ['syrzyk', 'ukrainian', 'source'],
+#         num_rows: 436
+#     })
+# })
+
+# Приклад перегляду першого запису з 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)
+
+- **Обсяг вибірки (v1.0)**: Датасет містить 4,359 ретельно відібраних прикладів. Це якісний 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.

split_stats.json

@@ -0,0 +1,10 @@
+{
+  "total": 4359,
+  "train": 3487,
+  "validation": 436,
+  "test": 436,
+  "train_ratio": 0.8,
+  "validation_ratio": 0.1,
+  "test_ratio": 0.1,
+  "seed": 42
+}

test.parquet

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:2715a9b02ce39723aabbad00e0b6f9143e4918f05881b897b4e54d283992c02b
+size 42157

train.parquet

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:51c62cd6731b58f76002df952cc0a559756c6a14766829656f9dabd7038650bf
+size 305507

validation.parquet

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:05a467ceb43002dc526411cf11261a029f9fce559b0f2bdb36775853548dbd13
+size 42804