Add README.md

README.md

@@ -1,54 +1,156 @@
 ---
+annotations_creators:
+- no-annotation
+language_creators:
+- found
+language:
+- en
+license: cc-by-4.0
+multilinguality:
+- monolingual
+size_categories:
+- n<1K
+source_datasets:
+- original
+task_categories:
+- tabular-classification
+- other
+task_ids: []
+tags:
+- africa
+- humanitarian
+- hdx
+- electric-sheep-africa
+- geodata
+- hxl
+- mli
+pretty_name: "Mali Qlik Sense Template-COD"
 dataset_info:
-  features:
-  - name: country_i_fr_name
-    dtype: string
-  - name: country_code_v_pcode
-    dtype: string
-  - name: shape_length
-    dtype: float64
-  - name: shape_area
-    dtype: float64
-  - name: country_code_v_pcode_alpha3
-    dtype: string
-  - name: adm1_i_fr_name
-    dtype: string
-  - name: adm1_code_v_pcode
-    dtype: string
-  - name: adm1_code_v_pcode_alpha3
-    dtype: string
-  - name: adm2_i_fr_name
-    dtype: string
-  - name: adm2_code_v_pcode
-    dtype: string
-  - name: adm2_code_v_pcode_alpha3
-    dtype: string
-  - name: adm3_i_fr_name
-    dtype: string
-  - name: adm3_code_v_pcode
-    dtype: string
-  - name: adm3_code_v_pcode_alpha3
-    dtype: string
-  - name: date_start
-    dtype: timestamp[ns]
-  - name: esa_source
-    dtype: string
-  - name: esa_processed
-    dtype: string
   splits:
-  - name: train
-    num_bytes: 107225
-    num_examples: 664
-  - name: test
-    num_bytes: 26738
-    num_examples: 166
-  download_size: 51665
-  dataset_size: 133963
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-  - split: test
-    path: data/test-*
+    - name: train
+      num_examples: 664
+    - name: test
+      num_examples: 166
 ---
+
+# Mali Qlik Sense Template-COD
+
+**Publisher:** ITOS (inactive) · **Source:** [HDX](https://data.humdata.org/dataset/qlik-sense-template-cod-mli) · **License:** `cc-by` · **Updated:** 2025-05-22
+
+---
+
+## Abstract
+
+(Beta) Qlik Sense COD template app and its source data including the administrative hierarchy table and geographical data (KML).   The KML files in this data set are optimized for Qlik Sense and are not the substitute for the original COD data sets used in the GIS applications.  To see the differences, refer CAVEATS/COMMENTS in the Metadata.  The data set is currently under the user acceptance testing phase.
+
+Each row in this dataset represents country-level aggregates. Temporal coverage is indicated by the `date_start` column(s). Geographic scope: **MLI**.
+
+*Curated into ML-ready Parquet format by [Electric Sheep Africa](https://huggingface.co/electricsheepafrica).*
+
+---
+
+## Dataset Characteristics
+
+| | |
+|---|---|
+| **Domain** | Humanitarian and development data |
+| **Unit of observation** | Country-level aggregates |
+| **Rows (total)** | 830 |
+| **Columns** | 17 (2 numeric, 14 categorical, 1 datetime) |
+| **Train split** | 664 rows |
+| **Test split** | 166 rows |
+| **Geographic scope** | MLI |
+| **Publisher** | ITOS (inactive) |
+| **HDX last updated** | 2025-05-22 |
+
+---
+
+## Variables
+
+**Geographic** — `country_i_fr_name` (Mali), `country_code_v_pcode` (ML), `country_code_v_pcode_alpha3` (MLI).
+
+**Temporal** — `date_start`.
+
+**Identifier / Metadata** — `adm1_i_fr_name` (Sikasso, Kayes, Segou), `adm1_code_v_pcode` (ML03, ML01, ML04), `adm1_code_v_pcode_alpha3` (MLI03, MLI01, MLI04), `adm2_i_fr_name` (Bamako, Sikasso, Kati), `adm2_code_v_pcode` (ML0901, ML0307, ML0205) and 6 others.
+
+**Other** — `shape_length` (range 0.011–70.3383), `shape_area` (range 0.0–106.824).
+
+---
+
+## Quick Start
+
+```python
+from datasets import load_dataset
+
+ds    = load_dataset("electricsheepafrica/africa-qlik-sense-template-cod-mli")
+train = ds["train"].to_pandas()
+test  = ds["test"].to_pandas()
+
+print(train.shape)
+train.head()
+```
+
+---
+
+## Schema
+
+| Column | Type | Null % | Range / Sample Values |
+|---|---|---|---|
+| `country_i_fr_name` | object | 0.0% | Mali |
+| `country_code_v_pcode` | object | 0.0% | ML |
+| `shape_length` | float64 | 0.0% | 0.011 – 70.3383 (mean 1.8163) |
+| `shape_area` | float64 | 0.0% | 0.0 – 106.824 (mean 0.512) |
+| `country_code_v_pcode_alpha3` | object | 0.0% | MLI |
+| `adm1_i_fr_name` | object | 0.1% | Sikasso, Kayes, Segou |
+| `adm1_code_v_pcode` | object | 0.1% | ML03, ML01, ML04 |
+| `adm1_code_v_pcode_alpha3` | object | 0.1% | MLI03, MLI01, MLI04 |
+| `adm2_i_fr_name` | object | 1.1% | Bamako, Sikasso, Kati |
+| `adm2_code_v_pcode` | object | 1.1% | ML0901, ML0307, ML0205 |
+| `adm2_code_v_pcode_alpha3` | object | 1.1% | MLI0901, MLI0307, MLI0205 |
+| `adm3_i_fr_name` | object | 7.0% | Commune III, Commune VI, Commune II |
+| `adm3_code_v_pcode` | object | 7.0% |  |
+| `adm3_code_v_pcode_alpha3` | object | 7.0% |  |
+| `date_start` | datetime64[ns] | 0.0% |  |
+| `esa_source` | object | 0.0% |  |
+| `esa_processed` | object | 0.0% |  |
+
+---
+
+## Numeric Summary
+
+| Column | Min | Max | Mean | Median |
+|---|---|---|---|---|
+| `shape_length` | 0.011 | 70.3383 | 1.8163 | 0.9379 |
+| `shape_area` | 0.0 | 106.824 | 0.512 | 0.037 |
+
+---
+
+## 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`. 3 column(s) with >80% missing values were removed: `adm4_code_v_pcode`, `adm4_code_v_pcode_alpha3`, `adm4_i_fr_name`. 1 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 ITOS (inactive) 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/qlik-sense-template-cod-mli) for the publisher's own methodology notes and caveats.
+
+---
+
+## Citation
+
+```bibtex
+@dataset{hdx_africa_qlik_sense_template_cod_mli,
+  title     = {Mali Qlik Sense Template-COD},
+  author    = {ITOS (inactive)},
+  year      = {2025},
+  url       = {https://data.humdata.org/dataset/qlik-sense-template-cod-mli},
+  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.*