add dataset card with configs + schema

README.md

@@ -0,0 +1,450 @@
+---
+license: odc-by
+task_categories:
+  - text-generation
+  - text-classification
+language:
+  - multilingual
+size_categories:
+  - n>1B
+tags:
+  - region
+  - geographic-provenance
+  - fineweb
+  - fineweb-2
+  - common-crawl
+  - multilingual
+configs:
+  - config_name: default
+    data_files:
+      - split: train
+        path: "data/**/*.parquet"
+  - config_name: fineweb_only
+    data_files:
+      - split: train
+        path: "data/**/fineweb-*.parquet"
+  - config_name: fineweb2_only
+    data_files:
+      - split: train
+        path: "data/**/fineweb2-*.parquet"
+  - config_name: lang_rus_Cyrl
+    data_files:
+      - split: train
+        path: "data/language_script=rus_Cyrl/**/*.parquet"
+  - config_name: lang_deu_Latn
+    data_files:
+      - split: train
+        path: "data/language_script=deu_Latn/**/*.parquet"
+  - config_name: lang_spa_Latn
+    data_files:
+      - split: train
+        path: "data/language_script=spa_Latn/**/*.parquet"
+  - config_name: lang_fra_Latn
+    data_files:
+      - split: train
+        path: "data/language_script=fra_Latn/**/*.parquet"
+  - config_name: lang_jpn_Jpan
+    data_files:
+      - split: train
+        path: "data/language_script=jpn_Jpan/**/*.parquet"
+  - config_name: lang_ita_Latn
+    data_files:
+      - split: train
+        path: "data/language_script=ita_Latn/**/*.parquet"
+  - config_name: lang_cmn_Hani
+    data_files:
+      - split: train
+        path: "data/language_script=cmn_Hani/**/*.parquet"
+  - config_name: lang_pol_Latn
+    data_files:
+      - split: train
+        path: "data/language_script=pol_Latn/**/*.parquet"
+  - config_name: lang_por_Latn
+    data_files:
+      - split: train
+        path: "data/language_script=por_Latn/**/*.parquet"
+  - config_name: lang_nld_Latn
+    data_files:
+      - split: train
+        path: "data/language_script=nld_Latn/**/*.parquet"
+  - config_name: lang_ces_Latn
+    data_files:
+      - split: train
+        path: "data/language_script=ces_Latn/**/*.parquet"
+  - config_name: lang_ron_Latn
+    data_files:
+      - split: train
+        path: "data/language_script=ron_Latn/**/*.parquet"
+  - config_name: lang_swe_Latn
+    data_files:
+      - split: train
+        path: "data/language_script=swe_Latn/**/*.parquet"
+  - config_name: lang_hun_Latn
+    data_files:
+      - split: train
+        path: "data/language_script=hun_Latn/**/*.parquet"
+  - config_name: lang_dan_Latn
+    data_files:
+      - split: train
+        path: "data/language_script=dan_Latn/**/*.parquet"
+  - config_name: lang_ukr_Cyrl
+    data_files:
+      - split: train
+        path: "data/language_script=ukr_Cyrl/**/*.parquet"
+  - config_name: lang_fas_Arab
+    data_files:
+      - split: train
+        path: "data/language_script=fas_Arab/**/*.parquet"
+  - config_name: lang_ell_Grek
+    data_files:
+      - split: train
+        path: "data/language_script=ell_Grek/**/*.parquet"
+  - config_name: lang_ind_Latn
+    data_files:
+      - split: train
+        path: "data/language_script=ind_Latn/**/*.parquet"
+  - config_name: lang_kor_Hang
+    data_files:
+      - split: train
+        path: "data/language_script=kor_Hang/**/*.parquet"
+  - config_name: lang_nob_Latn
+    data_files:
+      - split: train
+        path: "data/language_script=nob_Latn/**/*.parquet"
+  - config_name: lang_vie_Latn
+    data_files:
+      - split: train
+        path: "data/language_script=vie_Latn/**/*.parquet"
+  - config_name: lang_eng_Latn
+    data_files:
+      - split: train
+        path: "data/language_script=eng_Latn/**/*.parquet"
+  - config_name: lang_fin_Latn
+    data_files:
+      - split: train
+        path: "data/language_script=fin_Latn/**/*.parquet"
+  - config_name: lang_slk_Latn
+    data_files:
+      - split: train
+        path: "data/language_script=slk_Latn/**/*.parquet"
+  - config_name: lang_tur_Latn
+    data_files:
+      - split: train
+        path: "data/language_script=tur_Latn/**/*.parquet"
+  - config_name: lang_arb_Arab
+    data_files:
+      - split: train
+        path: "data/language_script=arb_Arab/**/*.parquet"
+  - config_name: lang_bul_Cyrl
+    data_files:
+      - split: train
+        path: "data/language_script=bul_Cyrl/**/*.parquet"
+  - config_name: lang_bos_Latn
+    data_files:
+      - split: train
+        path: "data/language_script=bos_Latn/**/*.parquet"
+  - config_name: lang_lit_Latn
+    data_files:
+      - split: train
+        path: "data/language_script=lit_Latn/**/*.parquet"
+  - config_name: region_RU
+    data_files:
+      - split: train
+        path: "data/**/region=RU/*.parquet"
+  - config_name: region_DE
+    data_files:
+      - split: train
+        path: "data/**/region=DE/*.parquet"
+  - config_name: region_JP
+    data_files:
+      - split: train
+        path: "data/**/region=JP/*.parquet"
+  - config_name: region_IT
+    data_files:
+      - split: train
+        path: "data/**/region=IT/*.parquet"
+  - config_name: region_FR
+    data_files:
+      - split: train
+        path: "data/**/region=FR/*.parquet"
+  - config_name: region_PL
+    data_files:
+      - split: train
+        path: "data/**/region=PL/*.parquet"
+  - config_name: region_CN
+    data_files:
+      - split: train
+        path: "data/**/region=CN/*.parquet"
+  - config_name: region_NL
+    data_files:
+      - split: train
+        path: "data/**/region=NL/*.parquet"
+  - config_name: region_BR
+    data_files:
+      - split: train
+        path: "data/**/region=BR/*.parquet"
+  - config_name: region_ES
+    data_files:
+      - split: train
+        path: "data/**/region=ES/*.parquet"
+  - config_name: region_UA
+    data_files:
+      - split: train
+        path: "data/**/region=UA/*.parquet"
+  - config_name: region_CZ
+    data_files:
+      - split: train
+        path: "data/**/region=CZ/*.parquet"
+  - config_name: region_EU
+    data_files:
+      - split: train
+        path: "data/**/region=EU/*.parquet"
+  - config_name: region_RO
+    data_files:
+      - split: train
+        path: "data/**/region=RO/*.parquet"
+  - config_name: region_HU
+    data_files:
+      - split: train
+        path: "data/**/region=HU/*.parquet"
+  - config_name: region_SE
+    data_files:
+      - split: train
+        path: "data/**/region=SE/*.parquet"
+  - config_name: region_DK
+    data_files:
+      - split: train
+        path: "data/**/region=DK/*.parquet"
+  - config_name: region_IR
+    data_files:
+      - split: train
+        path: "data/**/region=IR/*.parquet"
+  - config_name: region_GR
+    data_files:
+      - split: train
+        path: "data/**/region=GR/*.parquet"
+  - config_name: region_AR
+    data_files:
+      - split: train
+        path: "data/**/region=AR/*.parquet"
+  - config_name: region_CH
+    data_files:
+      - split: train
+        path: "data/**/region=CH/*.parquet"
+  - config_name: region_ID
+    data_files:
+      - split: train
+        path: "data/**/region=ID/*.parquet"
+  - config_name: region_MX
+    data_files:
+      - split: train
+        path: "data/**/region=MX/*.parquet"
+  - config_name: region_VN
+    data_files:
+      - split: train
+        path: "data/**/region=VN/*.parquet"
+  - config_name: region_NO
+    data_files:
+      - split: train
+        path: "data/**/region=NO/*.parquet"
+  - config_name: region_BE
+    data_files:
+      - split: train
+        path: "data/**/region=BE/*.parquet"
+  - config_name: region_KR
+    data_files:
+      - split: train
+        path: "data/**/region=KR/*.parquet"
+  - config_name: region_AT
+    data_files:
+      - split: train
+        path: "data/**/region=AT/*.parquet"
+  - config_name: region_SK
+    data_files:
+      - split: train
+        path: "data/**/region=SK/*.parquet"
+  - config_name: region_PT
+    data_files:
+      - split: train
+        path: "data/**/region=PT/*.parquet"
+  - config_name: region_FI
+    data_files:
+      - split: train
+        path: "data/**/region=FI/*.parquet"
+  - config_name: region_TW
+    data_files:
+      - split: train
+        path: "data/**/region=TW/*.parquet"
+  - config_name: region_TR
+    data_files:
+      - split: train
+        path: "data/**/region=TR/*.parquet"
+  - config_name: region_GB
+    data_files:
+      - split: train
+        path: "data/**/region=GB/*.parquet"
+  - config_name: region_CA
+    data_files:
+      - split: train
+        path: "data/**/region=CA/*.parquet"
+  - config_name: region_BG
+    data_files:
+      - split: train
+        path: "data/**/region=BG/*.parquet"
+  - config_name: region_CL
+    data_files:
+      - split: train
+        path: "data/**/region=CL/*.parquet"
+  - config_name: region_IL
+    data_files:
+      - split: train
+        path: "data/**/region=IL/*.parquet"
+  - config_name: region_IN
+    data_files:
+      - split: train
+        path: "data/**/region=IN/*.parquet"
+  - config_name: region_BY
+    data_files:
+      - split: train
+        path: "data/**/region=BY/*.parquet"
+---
+# FineWeb + FineWeb-2 with served-from region annotations (URL-only, resolved-only)
+
+A region-annotated, hive-partitioned view of [`HuggingFaceFW/fineweb`](https://huggingface.co/datasets/HuggingFaceFW/fineweb) (the `sample-100BT` slice) and [`HuggingFaceFW/fineweb-2`](https://huggingface.co/datasets/HuggingFaceFW/fineweb-2). Every record carries an ISO 3166-1 alpha-2 region label produced by the URL-only resolution pipeline described in the companion paper. **Records with `region == "XX"` (unresolved) have been dropped**; to access them, use the original FineWeb / FineWeb-2 datasets and rejoin on `(source_dataset, id)`.
+
+- **Records:** 2,960,753,780 (resolved-only)
+- **Locales (language_script × region):** 30,012
+- **Languages (resolved):** 525  •  **Regions:** 243
+- **Layout:** hive-partitioned `data/language_script={ls}/region={r}/{source_dataset}-*.parquet`
+
+> **Resolution rate, not precision.** The 57.20 % combined resolution rate (against the full input including XX) is recall-like — a measure of whether *any* label was produced, not whether it is correct. Label precision is not yet evaluated. Use the `region_confidence` column to filter (`high`/`medium`/`low` are the lookup-backed tiers; `ccTLD` and `url_hint` are weaker; rows with no signal were dropped).
+
+## Schema
+
+| Column | Type | Notes |
+|---|---|---|
+| `text`                  | string  | Document body, verbatim from the source dataset. |
+| `id`                    | string  | Source record id (UUID-like). Together with `source_dataset` uniquely identifies the source row. |
+| `dump`                  | string  | CommonCrawl dump id (e.g. `CC-MAIN-2017-04`). |
+| `url`                   | string  | The URL used for region resolution. |
+| `date`                  | string  | WARC date. |
+| `file_path`             | string  | Source WARC S3 path (for traceability). |
+| `language`              | string  | ISO 639-3 (FineWeb's `en` is normalised to `eng`). |
+| `language_script`       | string  | ISO 15924 (`Latn`, `Cyrl`, `Hani`, `Jpan`, `Arab`, …). |
+| `language_score`        | float64 | Source-dataset language-ID confidence. |
+| `token_count`           | int64   | FineWeb only (null for FineWeb-2). |
+| `minhash_cluster_size`  | int64   | FineWeb-2 only (null for FineWeb). |
+| `top_langs`             | string  | FineWeb-2 only (per-segment lang JSON, null for FineWeb). |
+| `region`                | string  | ISO 3166-1 alpha-2. **`XX` rows are excluded.** |
+| `locale`                | string  | `<language>_<script>-<region>` (e.g. `eng_Latn-GB`). |
+| `region_source`         | string  | `query` / `host_path` / `host` / `domain` / `url_hint` / `tld`. |
+| `region_confidence`     | string  | `high` / `medium` / `low` / `url_hint` / `ccTLD`. |
+| `region_content_share`  | float32 | A11 content-scan vote share (0.0 in this URL-only release). |
+| `region_top_rule`       | string  | `A1`–`A8` when the lookup CSV path was consulted, else empty. |
+| `source_dataset`        | string  | `"fineweb"` or `"fineweb2"`. |
+
+## Access patterns
+
+The repository is hive-partitioned so you can scope a load to a locale, a region, or a language without scanning the whole corpus.
+
+### By locale (`language_script`-`region`)
+
+```python
+from datasets import load_dataset
+
+ds = load_dataset(
+    "REPO_ID",
+    data_files="data/language_script=eng_Latn/region=GB/*.parquet",
+    split="train",
+)
+print(ds[0])
+```
+
+### By region (across all languages)
+
+```python
+ds = load_dataset(
+    "REPO_ID",
+    data_files="data/**/region=DE/*.parquet",
+    split="train",
+)
+```
+
+### By `language_script` (across all regions)
+
+```python
+ds = load_dataset(
+    "REPO_ID",
+    data_files="data/language_script=rus_Cyrl/**/*.parquet",
+    split="train",
+)
+```
+
+### Named configs (pre-declared in the dataset card)
+
+For the most common slices we predeclare configs so you can do:
+
+```python
+ds = load_dataset("REPO_ID", "lang_eng_Latn",  split="train")
+ds = load_dataset("REPO_ID", "region_GB",      split="train")
+ds = load_dataset("REPO_ID", "fineweb2_only",  split="train")
+ds = load_dataset("REPO_ID", "default",        split="train")  # everything
+```
+
+The named configs are convenience shortcuts; the `data_files` glob route works for *any* (`language_script`, `region`) combination, including those without a named config.
+
+### Filter by confidence
+
+`region_confidence` follows the pipeline's ladder. To get only the
+lookup-backed tiers (no bare-ccTLD fallback):
+
+```python
+ds = ds.filter(lambda x: x["region_confidence"] in ("high", "medium", "low"))
+```
+
+### Rejoin to the original corpora
+
+To get the XX (unresolved) rows back, or to verify a row against the
+source dataset:
+
+```python
+# source_dataset ∈ {"fineweb", "fineweb2"}, id is the per-source record id.
+src = "HuggingFaceFW/fineweb" if row["source_dataset"] == "fineweb" else "HuggingFaceFW/fineweb-2"
+# Streaming lookup; the source datasets do not have an id index, but
+# the (dump, url) tuple is unique in practice.
+```
+
+## Provenance
+
+- **FineWeb** rows come from the `sample-100BT` subset.
+- **FineWeb-2** rows come from the full ingest (5.03 B records), minus one corrupt parquet shard (`lit_Latn-XX/data-00084.parquet`, 1.98 M records — all unresolved, so they would have been dropped anyway).
+- Region labels are produced by the `region_lookup_v3` resolver and its 1.33 M-key URL lookup table. The pipeline is described in the companion paper (`paper.md` in the source tree).
+- **A11 content-scan is not enabled** in this release. `region_content_share` is 0 for every row; the `region_source = "content"` source value never fires.
+
+## Limitations
+
+- **Precision unmeasured.** No held-out gold set has been built yet. Treat labels as best-effort, not certified.
+- **`cmn_Hani` is preserved verbatim from FineWeb-2's source directories.** Simplified vs Traditional (Hans/Hant) is *not* distinguished; downstream consumers needing the split must derive it from `region` (CN/SG → Hans; TW/HK/MO → Hant) or by re-scanning text.
+- **Non-Latin / RTL URL handling is unaudited at scale.** Punycode IDN hosts (`xn--*`) resolve via the ccTLD fallback but not via host-key lookups built on Latin forms.
+- **No cross-corpus dedup.** A URL that appears in both FineWeb and FineWeb-2 produces two rows.
+
+## Citation
+
+```bibtex
+@misc{fineweb-region-urlonly-2026,
+  title  = {{FineWeb + FineWeb-2 URL-only region annotations}},
+  author = {Yusser Al-Ghussin},
+  year   = {2026},
+  url    = {https://huggingface.co/datasets/REPO_ID},
+}
+```
+
+## License
+
+Inherits from the source datasets:
+- FineWeb: ODC-By 1.0
+- FineWeb-2: ODC-By 1.0
+
+The annotation columns added by this work (`region`, `locale`,
+`region_source`, `region_confidence`, `region_content_share`,
+`region_top_rule`, `source_dataset`) are released under CC0-1.0.