Add README.md

README.md

@@ -1,82 +1,183 @@
 ---
+annotations_creators:
+- no-annotation
+language_creators:
+- found
+language:
+- en
+license: other
+multilinguality:
+- monolingual
+size_categories:
+- 10K<n<100K
+source_datasets:
+- original
+task_categories:
+- tabular-classification
+- tabular-regression
+task_ids: []
+tags:
+- africa
+- humanitarian
+- hdx
+- electric-sheep-africa
+- ports
+- trade
+- egy
+pretty_name: "Egypt: Daily Port Activity Data and Shipment Estimates"
 dataset_info:
-  features:
-  - name: date
-    dtype: timestamp[ns, tz=UTC]
-  - name: year
-    dtype: int64
-  - name: month
-    dtype: int64
-  - name: day
-    dtype: int64
-  - name: portid
-    dtype: string
-  - name: portname
-    dtype: string
-  - name: country
-    dtype: string
-  - name: iso3
-    dtype: string
-  - name: portcalls_container
-    dtype: int64
-  - name: portcalls_dry_bulk
-    dtype: int64
-  - name: portcalls_general_cargo
-    dtype: int64
-  - name: portcalls_roro
-    dtype: int64
-  - name: portcalls_tanker
-    dtype: int64
-  - name: portcalls_cargo
-    dtype: int64
-  - name: portcalls
-    dtype: int64
-  - name: import_container
-    dtype: int64
-  - name: import_dry_bulk
-    dtype: int64
-  - name: import_general_cargo
-    dtype: int64
-  - name: import_roro
-    dtype: int64
-  - name: import_tanker
-    dtype: int64
-  - name: import_cargo
-    dtype: int64
-  - name: import
-    dtype: int64
-  - name: export_container
-    dtype: int64
-  - name: export_dry_bulk
-    dtype: int64
-  - name: export_general_cargo
-    dtype: int64
-  - name: export_roro
-    dtype: int64
-  - name: export_tanker
-    dtype: int64
-  - name: export_cargo
-    dtype: int64
-  - name: export
-    dtype: int64
-  - name: esa_source
-    dtype: string
-  - name: esa_processed
-    dtype: string
   splits:
-  - name: train
-    num_bytes: 7275993
-    num_examples: 27705
-  - name: test
-    num_bytes: 1818903
-    num_examples: 6927
-  download_size: 1478083
-  dataset_size: 9094896
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
-  - split: test
-    path: data/test-*
+    - name: train
+      num_examples: 27705
+    - name: test
+      num_examples: 6926
 ---
+
+# Egypt: Daily Port Activity Data and Shipment Estimates
+
+**Publisher:** PortWatch · **Source:** [HDX](https://data.humdata.org/dataset/egypt-daily-port-activity-data-and-shipment-estimates) · **License:** `hdx-other` · **Updated:** 2026-04-21
+
+---
+
+## Abstract
+
+Daily count of port calls, estimates of incoming shipment volumes and outgoing shipment volumes (in metric tons) for ports in Egypt.
+
+Each row in this dataset represents country-level aggregates. Data was last updated on HDX on 2026-04-21. Geographic scope: **EGY**.
+
+*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)** | 34,632 |
+| **Columns** | 31 (24 numeric, 6 categorical, 0 datetime) |
+| **Train split** | 27,705 rows |
+| **Test split** | 6,926 rows |
+| **Geographic scope** | EGY |
+| **Publisher** | PortWatch |
+| **HDX last updated** | 2026-04-21 |
+
+---
+
+## Variables
+
+**Geographic** — `year` (range 2019.0–2026.0), `day` (range 1.0–31.0), `country` (Egypt), `iso3` (EGY), `portcalls_dry_bulk` (range 0.0–10.0) and 8 others.
+
+**Temporal** — `date`, `month` (range 1.0–12.0).
+
+**Identifier / Metadata** — `portid` (port23, port71, port191), `portname` (Alexandria, As Suways, Safaga), `esa_source` (HDX), `esa_processed` (2026-04-23).
+
+**Other** — `portcalls_container` (range 0.0–9.0), `portcalls_general_cargo` (range 0.0–16.0), `portcalls_roro` (range 0.0–5.0), `portcalls_tanker` (range 0.0–7.0), `portcalls_cargo` (range 0.0–26.0) and 7 others.
+
+---
+
+## Quick Start
+
+```python
+from datasets import load_dataset
+
+ds    = load_dataset("electricsheepafrica/africa-ports-egypt")
+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, UTC] | 0.0% |  |
+| `year` | int64 | 0.0% | 2019.0 – 2026.0 (mean 2022.1607) |
+| `month` | int64 | 0.0% | 1.0 – 12.0 (mean 6.3536) |
+| `day` | int64 | 0.0% | 1.0 – 31.0 (mean 15.6813) |
+| `portid` | object | 0.0% | port23, port71, port191 |
+| `portname` | object | 0.0% | Alexandria, As Suways, Safaga |
+| `country` | object | 0.0% | Egypt |
+| `iso3` | object | 0.0% | EGY |
+| `portcalls_container` | int64 | 0.0% | 0.0 – 9.0 (mean 0.6792) |
+| `portcalls_dry_bulk` | int64 | 0.0% | 0.0 – 10.0 (mean 0.4381) |
+| `portcalls_general_cargo` | int64 | 0.0% | 0.0 – 16.0 (mean 0.5248) |
+| `portcalls_roro` | int64 | 0.0% | 0.0 – 5.0 (mean 0.0825) |
+| `portcalls_tanker` | int64 | 0.0% | 0.0 – 7.0 (mean 0.3509) |
+| `portcalls_cargo` | int64 | 0.0% | 0.0 – 26.0 (mean 1.7246) |
+| `portcalls` | int64 | 0.0% | 0.0 – 28.0 (mean 2.0755) |
+| `import_container` | int64 | 0.0% | 0.0 – 287158.0 (mean 3478.7853) |
+| `import_dry_bulk` | int64 | 0.0% | 0.0 – 374413.0 (mean 11405.4003) |
+| `import_general_cargo` | int64 | 0.0% | 0.0 – 55007.0 (mean 774.3546) |
+| `import_roro` | int64 | 0.0% | 0.0 – 11281.0 (mean 62.2823) |
+| `import_tanker` | int64 | 0.0% | 0.0 – 606437.0 (mean 3920.0105) |
+| `import_cargo` | int64 | 0.0% | 0.0 – 436273.0 (mean 15720.9812) |
+| `import` | int64 | 0.0% | 0.0 – 618671.0 (mean 19641.0458) |
+| `export_container` | int64 | 0.0% | 0.0 – 244244.0 (mean 3589.924) |
+| `export_dry_bulk` | int64 | 0.0% | 0.0 – 172421.0 (mean 2910.501) |
+| `export_general_cargo` | int64 | 0.0% | 0.0 – 29727.0 (mean 592.8913) |
+| `export_roro` | int64 | 0.0% |  |
+| `export_tanker` | int64 | 0.0% |  |
+| `export_cargo` | int64 | 0.0% |  |
+| `export` | int64 | 0.0% |  |
+| `esa_source` | object | 0.0% | HDX |
+| `esa_processed` | object | 0.0% | 2026-04-23 |
+
+---
+
+## Numeric Summary
+
+| Column | Min | Max | Mean | Median |
+|---|---|---|---|---|
+| `year` | 2019.0 | 2026.0 | 2022.1607 | 2022.0 |
+| `month` | 1.0 | 12.0 | 6.3536 | 6.0 |
+| `day` | 1.0 | 31.0 | 15.6813 | 16.0 |
+| `portcalls_container` | 0.0 | 9.0 | 0.6792 | 0.0 |
+| `portcalls_dry_bulk` | 0.0 | 10.0 | 0.4381 | 0.0 |
+| `portcalls_general_cargo` | 0.0 | 16.0 | 0.5248 | 0.0 |
+| `portcalls_roro` | 0.0 | 5.0 | 0.0825 | 0.0 |
+| `portcalls_tanker` | 0.0 | 7.0 | 0.3509 | 0.0 |
+| `portcalls_cargo` | 0.0 | 26.0 | 1.7246 | 0.0 |
+| `portcalls` | 0.0 | 28.0 | 2.0755 | 1.0 |
+| `import_container` | 0.0 | 287158.0 | 3478.7853 | 0.0 |
+| `import_dry_bulk` | 0.0 | 374413.0 | 11405.4003 | 0.0 |
+| `import_general_cargo` | 0.0 | 55007.0 | 774.3546 | 0.0 |
+| `import_roro` | 0.0 | 11281.0 | 62.2823 | 0.0 |
+| `import_tanker` | 0.0 | 606437.0 | 3920.0105 | 0.0 |
+
+---
+
+## 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 PortWatch 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/egypt-daily-port-activity-data-and-shipment-estimates) for the publisher's own methodology notes and caveats.
+
+---
+
+## Citation
+
+```bibtex
+@dataset{hdx_africa_ports_egypt,
+  title     = {Egypt: Daily Port Activity Data and Shipment Estimates},
+  author    = {PortWatch},
+  year      = {2026},
+  url       = {https://data.humdata.org/dataset/egypt-daily-port-activity-data-and-shipment-estimates},
+  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.*