Create README.md

README.md

@@ -0,0 +1,18 @@
+# GEM References
+
+## What is it?
+
+This repository contains all the reference datasets that are used for running evaluation on the GEM benchmark. These datasets were originally hosted as a [GitHub release](https://github.com/GEM-benchmark/GEM-metrics/releases) on the [`GEM-metrics`](https://github.com/GEM-benchmark/GEM-metrics) repository, but have been migrated to the Hugging Face Hub.
+
+We provide a `convert_dataset_to_json.py` conversion script that converts the datasets in the GEM organisation to the JSON format expected by the `GEM-metrics` library. You can run the script as follows:
+
+```python
+python convert_datasets_to_json.py
+```
+
+This script will:
+
+* Download and convert the datasets under the GEM organisation to JSON format
+* Download the corresponding reference datasets from the GitHub release to the `github_references/` folder
+* Perform a diff validation between the converted and original reference datasets via the `jq` library
+