Upload README.md with huggingface_hub

README.md

@@ -1,33 +1,101 @@
----
-dataset_info:
-  features:
-  - name: repository_id
-    dtype: int64
-  - name: full_name
-    dtype: string
-  - name: description
-    dtype: string
-  - name: stars
-    dtype: int64
-  - name: language
-    dtype: string
-  - name: license
-    dtype: string
-  - name: readme
-    dtype: string
-  - name: readme_length
-    dtype: int64
-  - name: fetched_at
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 11400352
-    num_examples: 2203
-  download_size: 5836950
-  dataset_size: 11400352
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
----
+---
+language: pl
+license: other
+size_categories: 1K<n<10K
+tags:
+  - polish
+  - github
+  - readme
+  - code
+  - open-source
+  - developers
+---
+
+# Polish GitHub README Corpus — Polskie README z repozytoriów GitHub
+
+Korpus polskojęzycznych plików README z repozytoriów GitHub, wygenerowany z GitHub API na podstawie klasyfikacji językowych datasetu [github/multilingual-repositories](https://github.com/github/multilingual-repositories) (CC0-1.0).
+
+## Statystyki
+
+| Metryka | Wartość |
+|---|---|
+| Repozytoria (klasyfikacja PL) | 209,519 |
+| Pobrane README (90 min scrape) | 2,313 |
+| Po deduplikacji i filtrowaniu | 2,203 |
+| Znaki | 10,825,412 |
+| Słowa | 1,201,709 |
+| Tokeny (szac.) | ~1,622,307 (1.62M) |
+| Średnia długość README | 4,913 znaków |
+
+## Pola
+
+| Pole | Typ | Opis |
+|---|---|---|
+| `repository_id` | int | ID repozytorium na GitHubie |
+| `full_name` | string | Pełna nazwa (owner/repo) |
+| `description` | string | Opis repozytorium |
+| `stars` | int | Liczba gwiazdek |
+| `language` | string | Główny język programowania |
+| `license` | string | Licencja (SPDX) |
+| `readme` | string | Pełny tekst README |
+| `readme_length` | int | Liczba znaków README |
+| `fetched_at` | string | Data pobrania (ISO 8601) |
+
+## Przetwarzanie
+
+1. Pobranie datasetu `github/multilingual-repositories` (sparse checkout, ~1.3 GB Parquet).
+2. Filtrowanie po `lang_code='PL'`, konsensus ≥2 klasyfikatorów, confidence >0.5.
+3. Sortowanie po liczbie gwiazdek (najlepsze repozytoria pierwsze).
+4. Pobieranie metadanych i README przez GitHub API (token PAT, 5000 req/h).
+5. Deduplikacja po `repository_id`.
+6. Filtrowanie README < 100 znaków.
+7. Redakcja PII (numery telefonów → `[PHONE]`, emaile → `[EMAIL]`, numery PESEL → `[PESEL]`).
+8. Zapis processed JSONL + quality report.
+
+## Audyt jakości
+
+- **PII (przed redakcją):** 610 telefonów, 422 emaile, 32 PESEL → zredagowane
+- **Duplikaty:** 44 usunięte
+- **Odfiltrowane (<100 chars):** 66
+- **Werdykt:** Obiecujący, gotowy do dalszej ewaluacji
+
+## Licencje repozytoriów (top 10)
+
+| Licencja | Liczba |
+|---|---|
+| None | 1,216 |
+| MIT | 465 |
+| GPL-3.0 | 174 |
+| NOASSERTION | 103 |
+| Apache-2.0 | 79 |
+| AGPL-3.0 | 41 |
+| GPL-2.0 | 32 |
+| BSD-3-Clause | 17 |
+| CC0-1.0 | 12 |
+| LGPL-3.0 | 11 |
+
+## Główne języki programowania (top 10)
+
+| Język | Liczba |
+|---|---|
+| Python | 358 |
+| None | 288 |
+| JavaScript | 211 |
+| PHP | 148 |
+| HTML | 142 |
+| Java | 134 |
+| TypeScript | 134 |
+| Jupyter Notebook | 117 |
+| C++ | 110 |
+| C# | 96 |
+
+## Licencja
+
+Pliki README w repozytoriach GitHub podlegają licencjom poszczególnych repozytoriów (patrz pole `license`). Dataset klasyfikacyjny `github/multilingual-repositories` jest na licencji CC0-1.0 (domena publiczna).
+
+## Pipeline
+
+Kod pipeline: `C:/Users/Hipek/CascadeProjects/multilingual-repositories/`
+
+- `filter_pl.py` — filtrowanie polskich repozytoriów z datasetu Parquet (DuckDB).
+- `scrape_gh.py` — pobieranie README przez GitHub API z retry logic, rate limiting, time limit, auto-processing.