Olaroti commited on
Commit
2b1a05a
·
verified ·
1 Parent(s): 061ca71

Standardize Electric Sheep Africa dataset card

Browse files
Files changed (1) hide show
  1. README.md +103 -116
README.md CHANGED
@@ -1,158 +1,145 @@
1
  ---
2
- annotations_creators:
3
- - no-annotation
4
- language_creators:
5
- - found
6
  language:
7
  - en
8
- license: cc-by-4.0
9
- multilinguality:
10
- - monolingual
11
- size_categories:
12
- - n<1K
13
- source_datasets:
14
- - original
15
  task_categories:
16
  - tabular-classification
17
- task_ids: []
 
 
 
18
  tags:
19
- - africa
20
- - humanitarian
21
- - hdx
22
- - electric-sheep-africa
23
- - conflict-violence
24
- - displacement
25
- - internally-displaced-persons-idp
26
- - natural-disasters
27
- - ben
28
- pretty_name: "Benin - Internal Displacements (New Displacements) – IDPs"
29
- dataset_info:
30
- splits:
31
- - name: train
32
- num_examples: 5
33
- - name: test
34
- num_examples: 1
35
- ---
36
-
37
- # Benin - Internal Displacements (New Displacements) – IDPs
38
-
39
- **Publisher:** Internal Displacement Monitoring Centre (IDMC) · **Source:** [HDX](https://data.humdata.org/dataset/idmc-idp-data-ben) · **License:** `cc-by-igo` · **Updated:** 2026-03-18
40
-
41
  ---
42
 
43
- ## Abstract
44
 
45
- The [Global Internal Displacement Database (GIDD)](http://www.internal-displacement.org/database/displacement-data), maintained by the [Internal Displacement Monitoring Centre (IDMC)](https://www.internal-displacement.org/), provides comprehensive, validated annual estimates of internal displacement worldwide. It defines internally displaced persons (IDPs) in line with the [1998 Guiding Principles](https://www.internal-displacement.org/internal-displacement/guiding-principles-on-internal-displacement/), as people or groups of people who have been forced or obliged to flee or to leave their homes or places of habitual residence, in particular as a result of armed conflict, or to avoid the effects of armed conflict, situations of generalized violence, violations of human rights, or natural or human-made disasters and who have not crossed an international border.
46
 
 
 
 
 
47
 
48
- The GIDD tracks two primary metrics: "People Displaced" or population "Stock" figures, which represent the total number of people living in displacement at year-end, and "New Displacement," which counts new displacement incidents (population Flows) rather than individual people, accounting for potential multiple displacements by the same person. This dataset serves as a crucial resource for understanding long-term trends and validated displacement figures globally. For further detailed information and complete API specifications, users are encouraged to consult the official documentation at https://www.internal-displacement.org/database/api-documentation/.
49
 
 
50
 
51
- "Internally displaced persons - IDPs" refers to the number of people living in displacement as of the end of each year.
52
 
 
53
 
54
- "Internal displacements (New Displacements)" refers to the number of new cases or incidents of displacement recorded, rather than the number of people displaced. This is done because people may have been displaced more than once.
55
 
56
- Each row in this dataset represents country-level aggregates. Data was last updated on HDX on 2026-03-18. Geographic scope: **BEN**.
57
 
58
- *Curated into ML-ready Parquet format by [Electric Sheep Africa](https://huggingface.co/electricsheepafrica).*
59
-
60
- ---
61
-
62
- ## Dataset Characteristics
63
-
64
- | | |
65
  |---|---|
66
- | **Domain** | Conflict and security |
67
- | **Unit of observation** | Country-level aggregates |
68
- | **Rows (total)** | 7 |
69
- | **Columns** | 9 (5 numeric, 4 categorical, 0 datetime) |
70
- | **Train split** | 5 rows |
71
- | **Test split** | 1 rows |
72
- | **Geographic scope** | BEN |
73
- | **Publisher** | Internal Displacement Monitoring Centre (IDMC) |
74
- | **HDX last updated** | 2026-03-18 |
75
-
76
- ---
77
-
78
- ## Variables
79
-
80
- **Geographic** `iso3` (BEN), `country_name` (Benin), `year` (range 2018.0–2024.0), `new_displacement` (range 1231.0–6502.0), `new_displacement_rounded` (range 1200.0–6500.0) and 2 others.
81
-
82
- **Identifier / Metadata** `esa_source` (HDX), `esa_processed` (2026-04-06).
83
-
84
- ---
85
-
86
- ## Quick Start
87
 
88
  ```python
89
  from datasets import load_dataset
90
 
91
- ds = load_dataset("electricsheepafrica/africa-idmc-idp-data-ben")
92
- train = ds["train"].to_pandas()
93
- test = ds["test"].to_pandas()
94
 
95
- print(train.shape)
96
- train.head()
 
 
97
  ```
98
 
99
- ---
100
-
101
- ## Schema
102
 
103
- | Column | Type | Null % | Range / Sample Values |
104
- |---|---|---|---|
105
- | `iso3` | object | 0.0% | BEN |
106
- | `country_name` | object | 0.0% | Benin |
107
- | `year` | int64 | 0.0% | 2018.0 – 2024.0 (mean 2021.0) |
108
- | `new_displacement` | float64 | 57.1% | 1231.0 – 6502.0 (mean 3742.3333) |
109
- | `new_displacement_rounded` | float64 | 57.1% | 1200.0 – 6500.0 (mean 3733.3333) |
110
- | `total_displacement` | int64 | 0.0% | 1231.0 – 12501.0 (mean 5100.0) |
111
- | `total_displacement_rounded` | int64 | 0.0% | 1200.0 – 13000.0 (mean 5171.4286) |
112
- | `esa_source` | object | 0.0% | HDX |
113
- | `esa_processed` | object | 0.0% | 2026-04-06 |
114
-
115
- ---
116
-
117
- ## Numeric Summary
118
-
119
- | Column | Min | Max | Mean | Median |
120
- |---|---|---|---|---|
121
- | `year` | 2018.0 | 2024.0 | 2021.0 | 2021.0 |
122
- | `new_displacement` | 1231.0 | 6502.0 | 3742.3333 | 3494.0 |
123
- | `new_displacement_rounded` | 1200.0 | 6500.0 | 3733.3333 | 3500.0 |
124
- | `total_displacement` | 1231.0 | 12501.0 | 5100.0 | 3494.0 |
125
- | `total_displacement_rounded` | 1200.0 | 13000.0 | 5171.4286 | 3500.0 |
126
 
127
- ---
 
 
 
 
128
 
129
- ## Curation
130
 
131
- 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`. The dataset was split 80/20 into train and test partitions using a fixed random seed (42) and saved as Snappy-compressed Parquet.
 
 
 
132
 
133
- ---
134
 
135
- ## Limitations
 
 
 
 
136
 
137
- - Data originates from Internal Displacement Monitoring Centre (IDMC) and has not been independently validated by ESA.
138
- - Automated cleaning cannot correct for misreported values, definitional inconsistencies, or sampling bias in the original collection.
139
- - The following columns have >20% missing values and should be treated with caution in modelling: `new_displacement`, `new_displacement_rounded`.
140
- - Refer to the [original HDX dataset page](https://data.humdata.org/dataset/idmc-idp-data-ben) for the publisher's own methodology notes and caveats.
141
 
142
- ---
 
 
 
143
 
144
  ## Citation
145
 
146
  ```bibtex
147
- @dataset{hdx_africa_idmc_idp_data_ben,
148
- title = {Benin - Internal Displacements (New Displacements) – IDPs},
149
- author = {Internal Displacement Monitoring Centre (IDMC)},
150
- year = {2026},
151
- url = {https://data.humdata.org/dataset/idmc-idp-data-ben},
152
- note = {Repackaged for machine learning by Electric Sheep Africa (https://huggingface.co/electricsheepafrica)}
 
153
  }
154
  ```
155
 
 
 
 
 
 
 
 
 
 
 
156
  ---
157
 
158
- *[Electric Sheep Africa](https://huggingface.co/electricsheepafrica) Africa's ML dataset infrastructure. Lagos, Nigeria.*
 
1
  ---
2
+ license: cc-by-4.0
 
 
 
3
  language:
4
  - en
 
 
 
 
 
 
 
5
  task_categories:
6
  - tabular-classification
7
+ - tabular-regression
8
+ multilinguality: monolingual
9
+ size_categories:
10
+ - n<1K
11
  tags:
12
+ - "africa"
13
+ - "electric-sheep-africa"
14
+ - "open-data"
15
+ - "metadata-backed"
16
+ - "governance-security"
17
+ - "parquet"
18
+ - "tabular"
19
+ - "text"
20
+ - "humanitarian"
21
+ - "hdx"
22
+ - "conflict-violence"
23
+ - "displacement"
24
+ - "internally-displaced-persons-idp"
25
+ - "natural-disasters"
26
+ - "ben"
27
+ - "conflict"
28
+ - "violence"
29
+ pretty_name: "Benin - Internal Displacements (New Displacements) – IDPs | Africa (original)"
 
 
 
 
30
  ---
31
 
32
+ # Benin - Internal Displacements (New Displacements) – IDPs | Africa (original)
33
 
34
+ **Size category:** `n<1K` - **Formats:** `parquet` - **Sector:** governance_security - *Engineered by [Electric Sheep Africa](https://huggingface.co/electricsheepafrica)*
35
 
36
+ ![size](https://img.shields.io/badge/size-n%3C1K-blue)
37
+ ![sector](https://img.shields.io/badge/sector-governance_security-green)
38
+ ![downloads](https://img.shields.io/badge/HF_downloads-27-orange)
39
+ ![license](https://img.shields.io/badge/license-cc--by--4.0-lightgrey)
40
 
41
+ ## TL;DR
42
 
43
+ This dataset is part of the Electric Sheep Africa catalog on Hugging Face. It is indexed for African data discovery with standardized metadata, loading guidance, provenance notes, and analyst-oriented context.
44
 
45
+ ## What This Dataset Covers
46
 
47
+ Public datasets help analysts inspect structured evidence, build reproducible workflows, and compare patterns across domains.
48
 
49
+ Dataset context from the existing Hugging Face card: Benin - Internal Displacements (New Displacements) IDPs Publisher: Internal Displacement Monitoring Centre (IDMC) · Source: HDX · License: cc-by-igo · Updated: 2026-03-18 Abstract The Global Internal Displacement Database (GIDD), maintained by the Internal Displacement Monitoring Centre (IDMC), provides comprehensive, validated annual estimates of internal displacement worldwide. It defines internally displaced persons (IDPs) in line with the 1998 Guiding Principles… See the full description on the dataset page: https://huggingface.co/datasets/electricsheepafrica/africa-idmc-idp-data-ben.
50
 
51
+ ## Dataset Profile
52
 
53
+ | Field | Value |
 
 
 
 
 
 
54
  |---|---|
55
+ | Hugging Face repo | [`electricsheepafrica/africa-idmc-idp-data-ben`](https://huggingface.co/datasets/electricsheepafrica/africa-idmc-idp-data-ben) |
56
+ | Sector | governance_security |
57
+ | Topic tags | humanitarian, hdx, electric-sheep-africa, conflict-violence, displacement, internally-displaced-persons-idp, natural-disasters, ben |
58
+ | Modalities | `tabular`, `text` |
59
+ | Formats | `parquet` |
60
+ | Size category | `n<1K` |
61
+ | Countries | Benin |
62
+ | ISO3 coverage | `BEN` |
63
+ | Last modified on HF | `2026-04-06 07:20:45+00:00` |
64
+ | Inventory snapshot | `2026-07-16T16:00:34Z` |
65
+
66
+ ## How To Read This Dataset
67
+
68
+ - Start from the repository files and the dataset viewer when available.
69
+ - Treat the README context as a fast orientation layer; confirm variable definitions and units in the data files before modeling.
70
+ - Use explicit country columns when present. When geography is only implied by the title or source metadata, document that assumption in downstream analysis.
71
+ - Preserve missing values until you have a defensible imputation rule.
72
+
73
+ ## Usage
 
 
74
 
75
  ```python
76
  from datasets import load_dataset
77
 
78
+ ds = load_dataset("electricsheepafrica/africa-idmc-idp-data-ben")
79
+ print(ds)
 
80
 
81
+ split_name = next(iter(ds))
82
+ table = ds[split_name]
83
+ print(table.features)
84
+ print(table[:3])
85
  ```
86
 
87
+ ### Convert To Pandas When Tabular
 
 
88
 
89
+ ```python
90
+ from datasets import Dataset
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
91
 
92
+ first_split = ds[next(iter(ds))]
93
+ if isinstance(first_split, Dataset):
94
+ df = first_split.to_pandas()
95
+ print(df.head())
96
+ ```
97
 
98
+ ## Data Quality Notes
99
 
100
+ - This card was standardized from the Electric Sheep Africa Hugging Face metadata inventory.
101
+ - Exact schema, row counts, and source files should be inspected in the repository data files.
102
+ - Metadata gaps from the inventory: upstream_publisher.
103
+ - Do not infer policy meaning from labels alone; confirm definitions, units, and methods in the source material.
104
 
105
+ ## Source And Provenance
106
 
107
+ - **Source context:** original
108
+ - **Publisher/source attribution:** original
109
+ - **License:** [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)
110
+ - **Hugging Face URL:** [https://huggingface.co/datasets/electricsheepafrica/africa-idmc-idp-data-ben](https://huggingface.co/datasets/electricsheepafrica/africa-idmc-idp-data-ben)
111
+ - **Inventory retrieved at:** `2026-07-16T16:00:34Z`
112
 
113
+ ## Suggested Analyses
 
 
 
114
 
115
+ - Inspect schema and missingness before modeling.
116
+ - Profile variables by geography, time, and subgroup columns where present.
117
+ - Join with other Electric Sheep Africa datasets using explicit country, year, and indicator fields when available.
118
+ - Build reproducible notebooks that cite both the original source context and the Electric Sheep Africa Hugging Face repo.
119
 
120
  ## Citation
121
 
122
  ```bibtex
123
+ @misc{electric_sheep_africa_africa_idmc_idp_data_ben_2026,
124
+ title = {Benin - Internal Displacements (New Displacements) – IDPs | Africa (original)},
125
+ author = {original},
126
+ year = {2026},
127
+ url = {https://huggingface.co/datasets/electricsheepafrica/africa-idmc-idp-data-ben},
128
+ publisher = {Hugging Face Datasets, engineered by Electric Sheep Africa},
129
+ howpublished = {\url{https://huggingface.co/datasets/electricsheepafrica/africa-idmc-idp-data-ben}}
130
  }
131
  ```
132
 
133
+ ## License
134
+
135
+ Released under [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/).
136
+
137
+ Original source rights remain with the original publisher or data provider. Electric Sheep Africa engineering standardizes discovery metadata, documentation, and usage guidance for analysis on Hugging Face.
138
+
139
+ ## About Electric Sheep Africa
140
+
141
+ Electric Sheep Africa publishes ML-ready African public datasets on Hugging Face.
142
+
143
  ---
144
 
145
+ Provenance: metadata-backed README standardized 2026-08-12 by the Electric Sheep Africa README system. Inventory source: `catalog/esa_metadata_inventory/master_metadata.jsonl`.