add field descriptions and loading instructions to readme

README.md

@@ -22,13 +22,24 @@ A research tool you can use to view this data and the results of some classifier
 
 **[View our methodology](https://labs.climatepolicyradar.org/global-stocktake/)**.
 
+**Contents**
+
+- [Citing this data](#citing-this-data)
+- [Fields](#fields)
+- [Known issues](#known-issues)
+- [Usage in Python](#usage-in-python)
+  - [Loading metadata CSV](#loading-metadata-csv)
+  - [Loading text block data](#loading-text-block-data)
+
+---
+
 ## Citing this data
 
 ```
 @misc{Climate Policy Radar, title={Dataset for the first Global Stocktake}, url={http://gst1.org/}, author={Climate Policy Radar}}
 ```
 
-## Fields
+## Field descriptions
 
 - `author`: document author (str)
 - `author_is_party`: whether the author is a Party (national government) or not (bool)
@@ -42,19 +53,16 @@ A research tool you can use to view this data and the results of some classifier
 - `document_source_url`: URL for document
 - `document_variant`: used to identify translations. In `[nan, 'Translation', 'Original Language']`
 - `has_valid_text`: our heuristic about whether text is valid or not in the document based on the parser
-- `language`: **FIXME**
-- `languages`: **FIXME**
-- `link`: **FIXME**
+- `language`: language of the text block. Either `en` or `nan` - see known issues
 - `page_number`: page number of text block (0-indexed)
 - `text`: text in text block
 - `text_block_id`: identifier for a text block which is unique per document
 - `translated`: whether we have machine-translated the document to English. Where we have translated documents, both the original and translated exist.
-- `type`: **TODO**
-- `type_confidence`: confidence from our parser that the text block is of the labelled type
-- `types`: document types
+- `type`: type of text block. In `["Text", "Title", "List", "Table", "Figure","Ambiguous"]`
+- `type_confidence`: confidence from that the text block is of the labelled type
+- `types`: list of document types e.g. Nationally Determined Contribution, National Adaptation Plan (list[str])
 - `version`: in `['MAIN', 'ANNEX', 'SUMMARY', 'AMENDMENT', 'SUPPORTING DOCUMENTATION', 'PREVIOUS VERSION']`
 
-- 
 ## Known issues
 
 * Author names are sometimes corrupted
@@ -62,4 +70,20 @@ A research tool you can use to view this data and the results of some classifier
 
 ## Usage in Python
 
-TODO
+### Loading metadata CSV
+
+``` py
+metadata = pd.read_csv("metadata.csv")
+```
+
+### Loading text block data
+
+**The parquet file is recommended** as it stores the data much more (10x) more efficiently, meaning lower load on your system's memory requirements.
+
+``` py
+# Reading from parquet
+text_blocks = pd.read_parquet("full_text.parquet")
+
+# Reading from jsonl
+text_blocks = pd.read_json("full_text.jsonl", lines=True)
+```