pl-github-readmes / README.md
PiotrSty's picture
Upload README.md with huggingface_hub
70cd66b verified
|
Raw
History Blame Contribute Delete
3.17 kB
---
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 | 54,412,484 |
| Słowa | 6,605,910 |
| Tokeny (szac.) | ~8,917,978 (8.92M) |
| Średnia długość README | 3,105 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 | 13,311 |
| MIT | 2,257 |
| GPL-3.0 | 693 |
| NOASSERTION | 385 |
| Apache-2.0 | 330 |
| GPL-2.0 | 116 |
| AGPL-3.0 | 109 |
| Unlicense | 62 |
| BSD-3-Clause | 51 |
| CC0-1.0 | 50 |
## Główne języki programowania (top 10)
| Język | Liczba |
|---|---|
| Python | 2,942 |
| JavaScript | 2,138 |
| None | 1,804 |
| Java | 1,607 |
| C# | 1,095 |
| TypeScript | 1,086 |
| C++ | 1,086 |
| HTML | 1,085 |
| Jupyter Notebook | 750 |
| PHP | 725 |
## 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.