Update README.md

README.md

@@ -28,63 +28,60 @@ configs:
   data_files:
   - split: train
     path: data/train-*
+license: cc-by-4.0
 ---
 
 # National Climate Targets Dataset – Climate Policy Radar
 
-A dataset of climate targets found in national-level laws, policies and UNFCCC submissions from the [Climate Policy Radar database](https://app.climatepolicyradar.org).
+A dataset of climate targets made by national governments in their laws, policies and UNFCCC submissions which has been used to train a classifier. Text was sourced from the [Climate Policy Radar database](https://app.climatepolicyradar.org).
 
-## Dataset Details
+We define a target as an aim to achieve a specific outcome, that is quantifiable and is given a deadline. 
 
-### Dataset Description
+This dataset distinguishes between different types of targets:
 
-<!-- Provide a longer summary of what this dataset is. -->
+- **Reduction** (a.k.a. emissions reduction): a target referring to a reduction in greenhouse gas emissions, either economy-wide or for a sector.
+- **Net zero**: a commitment to balance GHG emissions with removal, effectively reducing the net emissions to zero.
+- **Other**: those that do not fit into the Reduction or Net Zero category but satisfy our definition of a target, e.g. renewable energy targets.
 
-<!-- dataset overview: class descriptions; overall counts -->
+*IMPORTANT NOTE:* this dataset has been used to train a machine learning model, and **is not a list of all climate targets published by national governments**.
 
-<!-- details of annotators -->
+## Dataset Description
 
-<!-- for more info see paper -->
+This dataset contains **2,610** examples containing 1,193 target mentions annotated in a multilabel setting: one text passage can be assigned to 0 or more target types. This breaks down as follows.
 
+|               |   Number of passages |
+|:--------------|--------:|
+| NZT           |     203 |
+| Reduction     |     359 |
+| Other         |     631 |
+| No Annotation |    1,584 |
 
-- **Curated by:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
+It was annotated by 3 domain-experts with steps taken to ensure consistency by measuring inter-annotator agreement.
 
-### Links
+All text is in English: the `translated` column describes whether it has been translated from another language using the Google Cloud Translation API. Further to the text and annotations, we also include characteristics of the documents we use to make equity calculations and anonymised assignment of annotations to annotators.
 
-<!-- Provide the basic links for the dataset. -->
-
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-
-## Uses
-
-<!-- Address questions around how the dataset is intended to be used. -->
+For more information on the dataset and its creation see **our paper TBA**.
 
-### Direct Use
+## License
 
-<!-- This section describes suitable use cases for the dataset. -->
+Our dataset is licensed as [CC by 4.0](https://creativecommons.org/licenses/by/4.0/).
 
-[More Information Needed]
+## Links
 
-### Out-of-Scope Use
-
-<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
-
-[More Information Needed]
+<!-- Provide the basic links for the dataset. -->
 
-## Dataset Structure
+- **Repository:** [coming soon]
+- **Paper** [coming soon]
 
-<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
+## Usage Guidelines
 
-[More Information Needed]
+<!-- domains it's built for; intended use; known safe and unsafe usage. -->
 
 ## Citation
 
-**TODO**<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
+[Coming soon]
+
 
 ## Authors & Contact
 
-[More Information Needed]
+[More Information Needed]