Add README.md

README.md

@@ -1,38 +1,155 @@
 ---
+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:
+- other
+task_ids: []
+tags:
+- africa
+- humanitarian
+- hdx
+- electric-sheep-africa
+- geodata
+- hazards-and-risk
+- humanitarian-response-plan-hrp
+- hxl
+- afg
+- bgd
+- bfa
+- bdi
+- cmr
+pretty_name: "Earthquakes: Hazard Data for Disaster Risk Assessment (selected countries)"
 dataset_info:
-  features:
-  - name: country_name
-    dtype: string
-  - name: admin1_name
-    dtype: string
-  - name: latitude
-    dtype: float64
-  - name: longitude
-    dtype: float64
-  - name: aggregation
-    dtype: string
-  - name: indicator
-    dtype: string
-  - name: value
-    dtype: float64
-  - name: esa_source
-    dtype: string
-  - name: esa_processed
-    dtype: string
   splits:
-  - name: train
-    num_bytes: 24257
-    num_examples: 264
-  - name: test
-    num_bytes: 6060
-    num_examples: 66
-  download_size: 19480
-  dataset_size: 30317
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-  - split: test
-    path: data/test-*
+    - name: train
+      num_examples: 264
+    - name: test
+      num_examples: 66
 ---
+
+# Earthquakes: Hazard Data for Disaster Risk Assessment (selected countries)
+
+**Publisher:** ETH Zürich - Weather and Climate Risks · **Source:** [HDX](https://data.humdata.org/dataset/climada-earthquake-dataset) · **License:** `cc-by` · **Updated:** 2025-04-15
+
+---
+
+## Abstract
+
+Earthquake hazard sets at 150 arcsec (ca. 4km) resolution, available for the entire globe and per country. Available as historic records from the USGS epicentres database and as a simple probabilistic sampling starting from the historic earthquake catalog, with 9 synthetic events per historic record. The presented data are maximum intensity on the Modified Mercalli intensity scale (MMI) over the historic record 1904-2017.
+
+Each row in this dataset represents first-level administrative unit observations. Data was last updated on HDX on 2025-04-15. Geographic scope: **AFG, BGD, BFA, BDI, CMR, CAF, TCD, COL, and 19 others**.
+
+*Curated into ML-ready Parquet format by [Electric Sheep Africa](https://huggingface.co/electricsheepafrica).*
+
+---
+
+## Dataset Characteristics
+
+| | |
+|---|---|
+| **Domain** | Humanitarian and development data |
+| **Unit of observation** | First-level administrative unit observations |
+| **Rows (total)** | 330 |
+| **Columns** | 9 (3 numeric, 6 categorical, 0 datetime) |
+| **Train split** | 264 rows |
+| **Test split** | 66 rows |
+| **Geographic scope** | AFG, BGD, BFA, BDI, CMR, CAF, TCD, COL, and 19 others |
+| **Publisher** | ETH Zürich - Weather and Climate Risks |
+| **HDX last updated** | 2025-04-15 |
+
+---
+
+## Variables
+
+**Geographic** — `country_name` (Afghanistan, Colombia, DR Congo), `admin1_name` (North, Bolívar, Amazonas), `latitude` (range -25.9531–51.3497), `longitude` (range -81.5417–98.758).
+
+**Outcome / Measurement** — `value` (range 0.0–10.5).
+
+**Identifier / Metadata** — `esa_source` (HDX), `esa_processed` (2026-04-04).
+
+**Other** — `aggregation` (max), `indicator` (earthquake, #indicator+name).
+
+---
+
+## Quick Start
+
+```python
+from datasets import load_dataset
+
+ds    = load_dataset("electricsheepafrica/africa-climada-earthquake-dataset")
+train = ds["train"].to_pandas()
+test  = ds["test"].to_pandas()
+
+print(train.shape)
+train.head()
+```
+
+---
+
+## Schema
+
+| Column | Type | Null % | Range / Sample Values |
+|---|---|---|---|
+| `country_name` | object | 0.0% | Afghanistan, Colombia, DR Congo |
+| `admin1_name` | object | 0.0% | North, Bolívar, Amazonas |
+| `latitude` | float64 | 0.3% | -25.9531 – 51.3497 (mean 14.2994) |
+| `longitude` | float64 | 0.3% | -81.5417 – 98.758 (mean 16.2111) |
+| `aggregation` | object | 0.3% | max |
+| `indicator` | object | 0.0% | earthquake, #indicator+name |
+| `value` | float64 | 0.3% | 0.0 – 10.5 (mean 5.5933) |
+| `esa_source` | object | 0.0% | HDX |
+| `esa_processed` | object | 0.0% | 2026-04-04 |
+
+---
+
+## Numeric Summary
+
+| Column | Min | Max | Mean | Median |
+|---|---|---|---|---|
+| `latitude` | -25.9531 | 51.3497 | 14.2994 | 10.2651 |
+| `longitude` | -81.5417 | 98.758 | 16.2111 | 29.9007 |
+| `value` | 0.0 | 10.5 | 5.5933 | 6.59 |
+
+---
+
+## 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) 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 ETH Zürich - Weather and Climate Risks and has not been independently validated by ESA.
+- Automated cleaning cannot correct for misreported values, definitional inconsistencies, or sampling bias in the original collection.
+- This dataset spans 27 countries; geographic and methodological inconsistencies across national boundaries may affect cross-country comparability.
+- Refer to the [original HDX dataset page](https://data.humdata.org/dataset/climada-earthquake-dataset) for the publisher's own methodology notes and caveats.
+
+---
+
+## Citation
+
+```bibtex
+@dataset{hdx_africa_climada_earthquake_dataset,
+  title     = {Earthquakes: Hazard Data for Disaster Risk Assessment (selected countries)},
+  author    = {ETH Zürich - Weather and Climate Risks},
+  year      = {2025},
+  url       = {https://data.humdata.org/dataset/climada-earthquake-dataset},
+  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.*