Update README.md

README.md

@@ -1,26 +1,38 @@
----
-license: apache-2.0
-dataset_info:
-  features:
-  - name: value
-    dtype: float64
-  - name: datasourceId
-    dtype: string
-  - name: variable
-    dtype: string
-  - name: field
-    dtype: string
-  - name: runId
-    dtype: string
-  splits:
-  - name: train
-    num_bytes: 673444
-    num_examples: 6383
-  download_size: 37395
-  dataset_size: 673444
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: metrics/train-*
----
+---
+license: apache-2.0
+dataset_info:
+  features:
+  - name: value
+    dtype: float64
+  - name: datasourceId
+    dtype: string
+  - name: variable
+    dtype: string
+  - name: field
+    dtype: string
+  - name: runId
+    dtype: string
+  splits:
+  - name: train
+    num_bytes: 673444
+    num_examples: 6383
+  download_size: 37395
+  dataset_size: 673444
+configs:
+- config_name: default
+  data_files:
+  - split: train
+    path: metrics/train-*
+---
+
+Repository for the Open Targets Platform release metrics.
+
+Each file is indexed by a `runId`. The format of this variable will depend on the type of the run:
+
+| Run type          | OT_RELEASE format | Example metrics output name |
+|-------------------|-------------------|-----------------------------|
+| Pre-ETL           | YY.MM_pre         | 23.12_pre                   |
+| Post-ETL, regular | YY.MM             | 23.12_2023-10-31            |
+| Post-ETL, PPP     | partners/YY.MM    | 23.12_ppp_2023-11-24        |
+
+👉 We have built a dashboard to explore these metrics and help in the QC of a new Open Targets release: https://open-targets-metrics.streamlit.app/