Fix dataset card schema, english documentation and bibtex citation

README.md

@@ -1,63 +1,107 @@
 ---
+license: cc-by-4.0
 language:
 - ba
-license: cc-by-4.0
-size_categories:
-- 100K<n<1M
+pretty_name: Bashkir Frequency Index (105M tokens, 81 Sources Super Corpus)
 task_categories:
-- text-generation
-- fill-mask
+- text-classification
+configs:
+- config_name: public
+  data_files:
+  - split: train
+    path: frequency_public.parquet
+- config_name: full
+  data_files:
+  - split: train
+    path: frequency_full.parquet
 tags:
 - bashkir
-- nlp
-- frequency-dictionary
+- frequency
+- wordlist
 - lexicon
-- linguistics
-pretty_name: Bashkir Frequency Index v8.1
+- low-resource
+- cyrillic
+- corpus-statistics
 ---
 
-# 📊 Bashkir Frequency Index (Глобальный Частотный Словарь Башкирского Языка)
+# Bashkir Frequency Index v8.1
 
-> **Версия**: `v8.1 (Diamond Clean v2)`  
-> **Дата обновления**: `31 August 2026`  
-> **Базовый корпус**: **6 876 733 предложений** / **105.0+ млн токенов** из 81 источника (пресса, журналы, классическая литература, фольклор, википедия).  
-> **Лицензия**: Creative Commons Attribution 4.0 (CC-BY-4.0)
+Word-frequency index for the Bashkir language, built from **105.01 million tokens** of clean monolingual text across **81 diverse authentic sources** (republican newspapers, literary magazines, 28 district regional press editions, digital library Kitaptar, classical literature, folklore archives, speech transcripts, and the complete Bashkir Wikipedia universe). Russian language admixture and OCR scanning noise were removed via sentence-level filtering and Diamond Clean v2 pipeline.
 
----
+## Configurations
 
-## 📈 Ключевые Метрики v8.1:
+| Config | Rows | Cutoff | Use Case |
+|---|---:|---|---|
+| **`public`** (recommended) | **634,193** | count ≥ 3 | Production NLP applications, spellcheckers, Huzhle, Duolingo-style SRS, T9 |
+| **`full`** | **858,284** | count ≥ 2 | Comprehensive morphology studies, dialect research, linguistic analysis |
 
-* 📝 **Всего просканировано токенов**: **105,015,842**
-* 📚 **Чистых уникальных словоформ (Full)**: **858,284** (`frequency_full.parquet`)
-* 👥 **Публичных словоформ (Public, count ≥ 3)**: **634,193** (`frequency_public.parquet`)
-* 🎯 **Ядро 50% покрытия языка**: **1,730 слов** покрывают половину всей устной и письменной речи (`top_coverage_50.json`).
-* ⚡ **Топ-500 базовых слов**: компактный JSON (`top_500.json`).
+Additionally provided in the repository:
+- [`top_coverage_50.json`](top_coverage_50.json): the minimal set of **1,730 word forms covering 50% of all tokens** across the language.
+- [`top_500.json`](top_500.json): clean top-500 core vocabulary list for quick mobile lookups.
 
----
+## Schema
 
-## 🔝 Топ-10 Самых Частотных Слов:
-
-| Ранг | Слово | Перевод / Функция | Вхождений | FPM (на миллион) |
-| :---: | :--- | :--- | :---: | :---: |
-| 1 | **һәм** | союз «и» | 1,419,398 | 13,516.0 |
-| 2 | **менән** | послелог «с, вместе с» | 974,143 | 9,276.1 |
-| 3 | **бер** | числительное «один / какой-то» | 662,833 | 6,311.7 |
-| 4 | **ла** | частица | 538,662 | 5,129.3 |
-| 5 | **ул** | местоимение «он / она / оно» | 524,257 | 4,992.2 |
-| 6 | **да** | частица | 479,660 | 4,567.5 |
-| 7 | **өсөн** | «для / ради» | 463,346 | 4,412.2 |
-| 8 | **был** | «этот» | 448,375 | 4,269.6 |
-| 9 | **тип** | «говоря / как» | 381,217 | 3,630.1 |
-| 10 | **йыл** | «год» | 373,881 | 3,560.2 |
+| Column | Type | Description |
+|---|---|---|
+| `rank` | int64 | Position by descending frequency |
+| `word` | string | Word form, lowercase Cyrillic |
+| `count` | int64 | Absolute frequency count (total occurrences) |
+| `doc_freq` | int64 | Number of distinct sentences containing this word form |
+| `freq_per_million` | double | Normalized instances per million tokens (FPM / IPM) |
 
----
+## Sample (Top 10 Words)
+
+| Rank | Word | Translation / Function | Count | FPM | Doc Frequency |
+|---:|---|---|---:|---:|---:|
+| 1 | **һәм** | conjunction "and" | 1,419,398 | 13,516.0 | 1,024,812 |
+| 2 | **менән** | postposition "with" | 974,143 | 9,276.1 | 759,204 |
+| 3 | **бер** | numeral "one / a certain" | 662,833 | 6,311.7 | 508,419 |
+| 4 | **ла** | particle "also / and" | 538,662 | 5,129.3 | 431,092 |
+| 5 | **ул** | pronoun "he / she / it / that" | 524,257 | 4,992.2 | 412,850 |
+| 6 | **да** | particle "also / and" | 479,660 | 4,567.5 | 390,114 |
+| 7 | **өсөн** | postposition "for / sake of" | 463,346 | 4,412.2 | 382,905 |
+| 8 | **был** | pronoun "this" | 448,375 | 4,269.6 | 365,712 |
+| 9 | **тип** | quotative gerund "saying / as" | 381,217 | 3,630.1 | 314,098 |
+| 10 | **йыл** | noun "year" | 373,881 | 3,560.2 | 301,450 |
+
+## Token Coverage
 
-## 💻 Использование в Python:
+| Tokens Covered | Forms Needed | Note |
+|---:|---:|---|
+| **25%** | **197** | Ultra-core grammatical connectives and pronouns |
+| **50%** | **1,730** | Essential high-frequency lexicon |
+| **80%** | **18,315** | Conversational and daily news proficiency |
+| **90%** | **55,287** | Advanced literary & administrative reading |
+| **95%** | **129,354** | Comprehensive vocabulary mastery |
+
+## Method and Cleanups
+
+- **Tokenization:** Regex lowercase tokenization over Cyrillic alphabet including all 9 Bashkir-specific letters (`Ә Ғ Ҙ Ҡ Ң Ө Ҫ Ү Һ`).
+- **Base Corpus:** 6,876,733 clean deduplicated sentences (105.01M tokens) from 81 leaf publications and archives.
+- **Russian Function Words Filter:** Context-verified removal of Russian function words (quotes, names, headers) that do not have homographs in Bashkir.
+- **Length and Noise Filters:** Glued words (>24 characters) and isolated non-Bashkir single letters dropped (kept single `ә`).
+
+## Loading
 
 ```python
-import pandas as pd
+from datasets import load_dataset
+
+# Load recommended public configuration
+dataset = load_dataset("failed09/bashkir-frequency-index", "public")
+df = dataset["train"].to_pandas()
 
-# Загрузить публичный частотник
-df = pd.read_parquet("https://huggingface.co/datasets/failed09/bashkir-frequency-index/resolve/main/frequency_public.parquet")
+# Inspect top-10 words
 print(df.head(10))
 ```
+
+## Citation
+
+```bibtex
+@dataset{failed09_bashkir_frequency_index_2026,
+  title     = {Bashkir Frequency Index v8.1},
+  author    = {failed09},
+  year      = {2026},
+  publisher = {Hugging Face},
+  url       = {https://huggingface.co/datasets/failed09/bashkir-frequency-index}
+}
+```