Add README.md

README.md

@@ -1,47 +1,159 @@
 ---
+annotations_creators:
+- no-annotation
+language_creators:
+- found
+language:
+- en
+license: cc-by-sa-4.0
+multilinguality:
+- monolingual
+size_categories:
+- n<1K
+source_datasets:
+- original
+task_categories:
+- other
+task_ids: []
+tags:
+- africa
+- humanitarian
+- hdx
+- electric-sheep-africa
+- languages
+- cpv
+pretty_name: "Cabo Verde: Languages"
 dataset_info:
-  features:
-  - name: location_code
-    dtype: string
-  - name: location_name
-    dtype: string
-  - name: location_level
-    dtype: int64
-  - name: language_code
-    dtype: string
-  - name: language_name
-    dtype: string
-  - name: language_rank
-    dtype: int64
-  - name: proportion_value
-    dtype: float64
-  - name: reliability_score
-    dtype: float64
-  - name: dataset_name
-    dtype: string
-  - name: url
-    dtype: string
-  - name: source
-    dtype: string
-  - name: datetime_published
-    dtype: timestamp[ns]
-  - name: date_creation
-    dtype: timestamp[ns]
-  - name: representivity_rating
-    dtype: string
-  - name: esa_source
-    dtype: string
-  - name: esa_processed
-    dtype: string
   splits:
-  - name: train
-    num_bytes: 584
-    num_examples: 2
-  download_size: 7737
-  dataset_size: 584
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
+    - name: train
+      num_examples: 1
+    - name: test
+      num_examples: 0
 ---
+
+# Cabo Verde: Languages
+
+**Publisher:** CLEAR Global (previously Translators without Borders) · **Source:** [HDX](https://data.humdata.org/dataset/cabo-verde-languages) · **License:** `cc-by-sa` · **Updated:** 2026-04-07
+
+---
+
+## Abstract
+
+Data on languages spoken in Cabo Verde, showing the main language spoken in the household by proportion of the population. Data is drawn from AfroBarometer. For more resources on the languages of Cabo Verde and language use in humanitarian contexts please visit: https://clearglobal.org/language-maps-and-data/
+
+Each row in this dataset represents time-series observations. Temporal coverage is indicated by the `datetime_published`, `date_creation` column(s). Geographic scope: **CPV**.
+
+*Curated into ML-ready Parquet format by [Electric Sheep Africa](https://huggingface.co/electricsheepafrica).*
+
+---
+
+## Dataset Characteristics
+
+| | |
+|---|---|
+| **Domain** | Demographics and population |
+| **Unit of observation** | Time-series observations |
+| **Rows (total)** | 2 |
+| **Columns** | 16 (4 numeric, 10 categorical, 2 datetime) |
+| **Train split** | 1 rows |
+| **Test split** | 0 rows |
+| **Geographic scope** | CPV |
+| **Publisher** | CLEAR Global (previously Translators without Borders) |
+| **HDX last updated** | 2026-04-07 |
+
+---
+
+## Variables
+
+**Geographic** — `location_code` (CPV), `location_name` (Cabo Verde), `location_level` (range 0.0–0.0), `reliability_score` (range 0.559–0.559), `representivity_rating` (moderate).
+
+**Temporal** — `datetime_published`, `date_creation`.
+
+**Demographic** — `language_code` (kabu1256, port1283), `language_name` (Kabuverdianu, Portuguese), `language_rank` (range 1.0–2.0).
+
+**Outcome / Measurement** — `proportion_value` (range 0.0017–0.9983).
+
+**Identifier / Metadata** — `dataset_name` (Cabo Verde Round 8 data (2021)), `source` (AfroBarometer), `esa_source` (HDX), `esa_processed` (2026-04-07).
+
+**Other** — `url` (https://www.afrobarometer.org/wp-content/uploads/2022/06/afrobarometer_release-data_cve_r8_pt_2021-03-31.sav).
+
+---
+
+## Quick Start
+
+```python
+from datasets import load_dataset
+
+ds    = load_dataset("electricsheepafrica/africa-cabo-verde-languages")
+train = ds["train"].to_pandas()
+test  = ds["test"].to_pandas()
+
+print(train.shape)
+train.head()
+```
+
+---
+
+## Schema
+
+| Column | Type | Null % | Range / Sample Values |
+|---|---|---|---|
+| `location_code` | object | 0.0% | CPV |
+| `location_name` | object | 0.0% | Cabo Verde |
+| `location_level` | int64 | 0.0% | 0.0 – 0.0 (mean 0.0) |
+| `language_code` | object | 0.0% | kabu1256, port1283 |
+| `language_name` | object | 0.0% | Kabuverdianu, Portuguese |
+| `language_rank` | int64 | 0.0% | 1.0 – 2.0 (mean 1.5) |
+| `proportion_value` | float64 | 0.0% | 0.0017 – 0.9983 (mean 0.5) |
+| `reliability_score` | float64 | 0.0% | 0.559 – 0.559 (mean 0.559) |
+| `dataset_name` | object | 0.0% | Cabo Verde Round 8 data (2021) |
+| `url` | object | 0.0% | https://www.afrobarometer.org/wp-content/uploads/2022/06/afrobarometer_release-data_cve_r8_pt_2021-03-31.sav |
+| `source` | object | 0.0% | AfroBarometer |
+| `datetime_published` | datetime64[ns] | 0.0% |  |
+| `date_creation` | datetime64[ns] | 0.0% |  |
+| `representivity_rating` | object | 0.0% | moderate |
+| `esa_source` | object | 0.0% | HDX |
+| `esa_processed` | object | 0.0% | 2026-04-07 |
+
+---
+
+## Numeric Summary
+
+| Column | Min | Max | Mean | Median |
+|---|---|---|---|---|
+| `location_level` | 0.0 | 0.0 | 0.0 | 0.0 |
+| `language_rank` | 1.0 | 2.0 | 1.5 | 1.5 |
+| `proportion_value` | 0.0017 | 0.9983 | 0.5 | 0.5 |
+| `reliability_score` | 0.559 | 0.559 | 0.559 | 0.559 |
+
+---
+
+## Curation
+
+Raw data was downloaded from HDX via the CKAN API and converted to Parquet. Column names were lowercased and standardised to snake_case. Common missing-value markers (`N/A`, `null`, `none`, `-`, `unknown`, `no data`, `#N/A`) were unified to `NaN`. 2 column(s) were cast from string to numeric or datetime based on parse-success rate (>85% threshold). The dataset was split 80/20 into train and test partitions using a fixed random seed (42) and saved as Snappy-compressed Parquet.
+
+---
+
+## Limitations
+
+- Data originates from CLEAR Global (previously Translators without Borders) and has not been independently validated by ESA.
+- Automated cleaning cannot correct for misreported values, definitional inconsistencies, or sampling bias in the original collection.
+- Refer to the [original HDX dataset page](https://data.humdata.org/dataset/cabo-verde-languages) for the publisher's own methodology notes and caveats.
+
+---
+
+## Citation
+
+```bibtex
+@dataset{hdx_africa_cabo_verde_languages,
+  title     = {Cabo Verde: Languages},
+  author    = {CLEAR Global (previously Translators without Borders)},
+  year      = {2026},
+  url       = {https://data.humdata.org/dataset/cabo-verde-languages},
+  note      = {Repackaged for machine learning by Electric Sheep Africa (https://huggingface.co/electricsheepafrica)}
+}
+```
+
+---
+
+*[Electric Sheep Africa](https://huggingface.co/electricsheepafrica) — Africa's ML dataset infrastructure. Lagos, Nigeria.*