Update README.md

README.md

@@ -68,4 +68,45 @@ configs:
   data_files:
   - split: train
     path: data/train-*
+license: apache-2.0
+task_categories:
+- text-classification
+language:
+- en
+- fr
+- es
+- de
+tags:
+- finance
+- climate
+pretty_name: International Aid Transparency Initiative (IATI) Policy Marker Dataset
+size_categories:
+- 100K<n<1M
 ---
+
+# International Aid Transparency Initiative (IATI) Policy Marker Dataset
+
+A multi-purpose dataset including all activity title and description text published to IATI with metadata for policy markers.
+For more information on IATI policy markers, see the [element page](https://iatistandard.org/en/iati-standard/203/activity-standard/iati-activities/iati-activity/policy-marker/) on the IATI Standard Website.
+IATI is a living data source, and this dataset was last updated on March 13, 2024. For the code to generate an updated version of this dataset, please see my Github repository [here](https://github.com/akmiller01/iati-policy-marker-hf-dataset).
+
+For any given policy marker in this dataset, there are two columns. One indicates whether the publisher utilizes the policy marker at all (e.g. `gender_equality`), and the other represents the marker significance (e.g. `gender_equality_sig`).
+The language column is pipe separated. It should be mostly ISO 639, but it's a free-text field so there may be other values.
+
+A suggested use would be:
+
+```
+from datasets import load_dataset
+
+iati = load_dataset("alex-miller/iati-policy-markers", split="train")
+gender_relevant_iati = iati.filter(lambda example: example["gender_equality"]).rename_column("gender_equality_sig", "label")
+cols_to_remove = gender_relevant_iati.column_names
+cols_to_remove.remove("text")
+cols_to_remove.remove("label")
+gender_relevant_iati = gender_relevant_iati.remove_columns(cols_to_remove)
+dataset = gender_relevant_iati.class_encode_column("label").train_test_split(
+    test_size=0.2,
+    stratify_by_column="label",
+    shuffle=True,
+)
+```