lszoszk commited on
Commit
bd91c22
·
verified ·
1 Parent(s): dd42ee5

Correct mechanism totals and pipeline description; add card changelog

Browse files
Files changed (1) hide show
  1. README.md +20 -9
README.md CHANGED
@@ -65,22 +65,28 @@ Built on the [OHCHR Universal Human Rights Index](https://uhri.ohchr.org) (UHRI)
65
  | Mechanism | Records | Bodies |
66
  |---|---|---|
67
  | Universal Periodic Review (UPR) | 127,625 | 1 |
68
- | Treaty Bodies | ~103,000 | 12 (CCPR, CAT, CERD, CEDAW, CRC, CESCR, CMW, CRPD, CED, SPT, CRC-OP-AC, CRC-OP-SC) |
69
- | Special Procedures (SR, IE, WG) | ~37,000 | 57 |
 
 
70
 
71
  **198 state parties** covered, including Cook Islands, Niue (non-UN-member states), State of Palestine\*, Holy See (UN observer states), and Kosovo\* (contested status).
72
 
73
  ## Cleaning pipeline (5 stages)
74
 
75
- | Stage | Issue | Records affected |
 
 
76
  |---|---|---|
77
- | 1 | OCR/encoding artefacts (ligatures, spacing, smart quotes) | ~8,000 |
78
- | 2 | Structural normalisation (section headings, paragraph markers) | ~3,500 |
79
- | 3 | Deduplication of near-identical records | ~1,200 |
80
- | 4 | Country backfill from UN document symbol | 106 |
81
- | 5 | Body name normalisation (78 → 70 unique bodies) | 1,481 |
 
 
82
 
83
- The `text_cleaned` field reflects all five stages. `text_original` preserves the raw OHCHR export text.
84
 
85
  ## Schema
86
 
@@ -144,3 +150,8 @@ Source data © OHCHR — shared freely and without restriction per the **[UHRI d
144
  > ⚠️ The OHCHR data policy may change. Always consult the current terms at [uhri.ohchr.org/en/our-data-api](https://uhri.ohchr.org/en/our-data-api) before redistributing. This dataset card reflects the policy as of 2026-05-18.
145
 
146
  Cleaning pipeline, normalisation, Stage 4 country backfill, and all metadata additions © L. Szoszkiewicz (Adam Mickiewicz University, Poznań), released under [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/) — free for research and education, commercial use requires permission.
 
 
 
 
 
 
65
  | Mechanism | Records | Bodies |
66
  |---|---|---|
67
  | Universal Periodic Review (UPR) | 127,625 | 1 |
68
+ | Treaty Bodies | 119,532 | 12 (CCPR, CAT, CERD, CEDAW, CRC, CESCR, CMW, CRPD, CED, SPT, CRC-OP-AC, CRC-OP-SC) |
69
+ | Special Procedures (SR, IE, WG) | 20,514 | 57 |
70
+
71
+ Totals are exact counts over this dataset's `body` field (127,625 + 119,532 + 20,514 = 267,671) and can be reproduced with `collections.Counter(ds["train"]["body"])`.
72
 
73
  **198 state parties** covered, including Cook Islands, Niue (non-UN-member states), State of Palestine\*, Holy See (UN observer states), and Kosovo\* (contested status).
74
 
75
  ## Cleaning pipeline (5 stages)
76
 
77
+ The canonical pipeline description (with full detail and examples) lives on the dashboard's [Methodology page](https://lszoszk.github.io/UnitedNations_recommendations/dashboard.html#view=methodology). Summary:
78
+
79
+ | Stage | What it does | Scale |
80
  |---|---|---|
81
+ | 1 | Rule-based OCR & HTML repair (no AI): stray tags, mid-word OCR splits (`develop- ment` → `development`), whitespace, broken citations | Stages 1–4 together edited ~56,000 records (≈21 % of the dataset) |
82
+ | 2 | LLM-assisted residue review for hard OCR corruption (bounded prompt, structural validation) | 412 records (0.15 %) |
83
+ | 3 | Deterministic `annotation_type` normalisation (multilingual regex classifier, audit-tagged) | 2,603 of ~3,294 missing/UUID-coded types re-labelled |
84
+ | 4 | Country backfill from the UN document symbol (`CEDAW/C/ALB/CO/4` → Albania) | 106 records |
85
+ | 5 | Artefact drop — rows with no citable content (empty placeholders, duplicate annotation IDs, HTML-only scaffolding) | 11 rows (267,682 → 267,671) |
86
+
87
+ `text_cleaned` reflects Stages 1–2 (text repair); Stages 3–5 act on metadata and row selection. `text_original` preserves the raw OHCHR export text.
88
 
89
+ **Applied data fixes (included in this parquet):** body-name normalisation merged duplicate issuing-body spellings (six treaty bodies and several Special-Procedure mandates appeared under both short codes and long names upstream) and resolved 20 blank `body` values from their document symbols — **1,481 rows changed, 78 → 70 distinct bodies**. The same fixes are folded into the live dashboard's data pipeline.
90
 
91
  ## Schema
92
 
 
150
  > ⚠️ The OHCHR data policy may change. Always consult the current terms at [uhri.ohchr.org/en/our-data-api](https://uhri.ohchr.org/en/our-data-api) before redistributing. This dataset card reflects the policy as of 2026-05-18.
151
 
152
  Cleaning pipeline, normalisation, Stage 4 country backfill, and all metadata additions © L. Szoszkiewicz (Adam Mickiewicz University, Poznań), released under [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/) — free for research and education, commercial use requires permission.
153
+
154
+ ## Card changelog
155
+
156
+ - **2026-06-11** — corrected the mechanism totals (Treaty Bodies 119,532; Special Procedures 20,514 — previously listed as rough estimates that were each ~16k off) and replaced the pipeline summary with the canonical five-stage description matching the published methodology.
157
+ - **2026-05-18** — initial release.