Add README.md

README.md

@@ -1,56 +1,165 @@
 ---
+annotations_creators:
+- no-annotation
+language_creators:
+- found
+language:
+- en
+license: cc-by-4.0
+multilinguality:
+- monolingual
+size_categories:
+- 10K<n<100K
+source_datasets:
+- original
+task_categories:
+- tabular-regression
+- other
+task_ids: []
+tags:
+- africa
+- humanitarian
+- hdx
+- electric-sheep-africa
+- economics
+- food-security
+- indicators
+- markets
+- sen
+pretty_name: "Senegal - Food Prices"
 dataset_info:
-  features:
-  - name: date
-    dtype: timestamp[ns]
-  - name: admin1
-    dtype: string
-  - name: admin2
-    dtype: string
-  - name: market
-    dtype: string
-  - name: market_id
-    dtype: int64
-  - name: latitude
-    dtype: float64
-  - name: longitude
-    dtype: float64
-  - name: category
-    dtype: string
-  - name: commodity
-    dtype: string
-  - name: commodity_id
-    dtype: int64
-  - name: unit
-    dtype: string
-  - name: priceflag
-    dtype: string
-  - name: pricetype
-    dtype: string
-  - name: currency
-    dtype: string
-  - name: price
-    dtype: float64
-  - name: usdprice
-    dtype: float64
-  - name: esa_source
-    dtype: string
-  - name: esa_processed
-    dtype: string
   splits:
-  - name: train
-    num_bytes: 6267437
-    num_examples: 34336
-  - name: test
-    num_bytes: 1566317
-    num_examples: 8584
-  download_size: 765745
-  dataset_size: 7833754
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-  - split: test
-    path: data/test-*
+    - name: train
+      num_examples: 34336
+    - name: test
+      num_examples: 8584
 ---
+
+# Senegal - Food Prices
+
+**Publisher:** WFP - World Food Programme · **Source:** [HDX](https://data.humdata.org/dataset/wfp-food-prices-for-senegal) · **License:** `cc-by-igo` · **Updated:** 2026-04-05
+
+---
+
+## Abstract
+
+This dataset contains Food Prices data for Senegal, sourced from the World Food Programme Price Database. The World Food Programme Price Database covers foods such as maize, rice, beans, fish, and sugar for 98 countries and some 3000 markets. It is updated weekly but contains to a large extent monthly data. The data goes back as far as 1992 for a few countries, although many countries started reporting from 2003 or thereafter.
+
+Each row in this dataset represents subnational administrative unit observations. Temporal coverage is indicated by the `date` column(s). Geographic scope: **SEN**.
+
+*Curated into ML-ready Parquet format by [Electric Sheep Africa](https://huggingface.co/electricsheepafrica).*
+
+---
+
+## Dataset Characteristics
+
+| | |
+|---|---|
+| **Domain** | Food security and nutrition |
+| **Unit of observation** | Subnational administrative unit observations |
+| **Rows (total)** | 42,920 |
+| **Columns** | 18 (6 numeric, 11 categorical, 1 datetime) |
+| **Train split** | 34,336 rows |
+| **Test split** | 8,584 rows |
+| **Geographic scope** | SEN |
+| **Publisher** | WFP - World Food Programme |
+| **HDX last updated** | 2026-04-05 |
+
+---
+
+## Variables
+
+**Geographic** — `admin1` (Fatick, Diourbel, Thies), `admin2` (Fatick, Dakar, Kolda), `latitude` (range 12.48–16.52), `longitude` (range -17.46–-11.95), `category` (cereals and tubers, pulses and nuts) and 4 others.
+
+**Temporal** — `date`.
+
+**Outcome / Measurement** — `priceflag` (actual), `price` (range 90.0–1816.5), `usdprice` (range 0.2–2.95).
+
+**Identifier / Metadata** — `market_id` (range 405.0–5234.0), `esa_source` (HDX), `esa_processed`.
+
+**Other** — `market` (Tilene, Kaolack, Louga), `unit` (KG).
+
+---
+
+## Quick Start
+
+```python
+from datasets import load_dataset
+
+ds    = load_dataset("electricsheepafrica/africa-wfp-food-prices-for-senegal")
+train = ds["train"].to_pandas()
+test  = ds["test"].to_pandas()
+
+print(train.shape)
+train.head()
+```
+
+---
+
+## Schema
+
+| Column | Type | Null % | Range / Sample Values |
+|---|---|---|---|
+| `date` | datetime64[ns] | 0.0% |  |
+| `admin1` | object | 0.0% | Fatick, Diourbel, Thies |
+| `admin2` | object | 0.0% | Fatick, Dakar, Kolda |
+| `market` | object | 0.0% | Tilene, Kaolack, Louga |
+| `market_id` | int64 | 0.0% | 405.0 – 5234.0 (mean 480.9576) |
+| `latitude` | float64 | 0.0% | 12.48 – 16.52 (mean 14.3651) |
+| `longitude` | float64 | 0.0% | -17.46 – -11.95 (mean -15.6127) |
+| `category` | object | 0.0% | cereals and tubers, pulses and nuts |
+| `commodity` | object | 0.0% | Rice (imported), Millet, Maize (local) |
+| `commodity_id` | int64 | 0.0% | 56.0 – 201.0 (mean 87.4315) |
+| `unit` | object | 0.0% | KG |
+| `priceflag` | object | 0.0% | actual |
+| `pricetype` | object | 0.0% | Retail |
+| `currency` | object | 0.0% | XOF |
+| `price` | float64 | 0.0% | 90.0 – 1816.5 (mean 326.903) |
+| `usdprice` | float64 | 0.0% | 0.2 – 2.95 (mean 0.5878) |
+| `esa_source` | object | 0.0% | HDX |
+| `esa_processed` | object | 0.0% |  |
+
+---
+
+## Numeric Summary
+
+| Column | Min | Max | Mean | Median |
+|---|---|---|---|---|
+| `market_id` | 405.0 | 5234.0 | 480.9576 | 431.0 |
+| `latitude` | 12.48 | 16.52 | 14.3651 | 14.54 |
+| `longitude` | -17.46 | -11.95 | -15.6127 | -16.17 |
+| `commodity_id` | 56.0 | 201.0 | 87.4315 | 71.0 |
+| `price` | 90.0 | 1816.5 | 326.903 | 275.0 |
+| `usdprice` | 0.2 | 2.95 | 0.5878 | 0.51 |
+
+---
+
+## 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`. 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 WFP - World Food Programme 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/wfp-food-prices-for-senegal) for the publisher's own methodology notes and caveats.
+
+---
+
+## Citation
+
+```bibtex
+@dataset{hdx_africa_wfp_food_prices_for_senegal,
+  title     = {Senegal - Food Prices},
+  author    = {WFP - World Food Programme},
+  year      = {2026},
+  url       = {https://data.humdata.org/dataset/wfp-food-prices-for-senegal},
+  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.*