kdutia commited on
Commit
a2018aa
1 Parent(s): db2e0d0

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +31 -2
README.md CHANGED
@@ -18,14 +18,43 @@ The files in this dataset are as follows:
18
  - `metadata.csv`: a CSV containing document metadata for each document we have collected. **This metadata may not be the same as what's stored in the source databases** – we have cleaned and added metadata where it's corrupted or missing.
19
  - `full_text.jsonl`: a jsonlines file containing the full text of each document we have parsed. Each row is a text block (paragraph) with all the associated text block and document metadata.
20
 
 
 
 
 
21
  ## Citing this data
22
 
23
- TODO
 
 
24
 
25
  ## Fields
26
 
27
- TODO
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
28
 
 
29
  ## Known issues
30
 
31
  * Author names are sometimes corrupted
 
18
  - `metadata.csv`: a CSV containing document metadata for each document we have collected. **This metadata may not be the same as what's stored in the source databases** – we have cleaned and added metadata where it's corrupted or missing.
19
  - `full_text.jsonl`: a jsonlines file containing the full text of each document we have parsed. Each row is a text block (paragraph) with all the associated text block and document metadata.
20
 
21
+ A research tool you can use to view this data and the results of some classifiers run on it is at [gst1.org](https://gst1.org).
22
+
23
+ **[View our methodology](https://labs.climatepolicyradar.org/global-stocktake/)**.
24
+
25
  ## Citing this data
26
 
27
+ ```
28
+ @misc{Climate Policy Radar, title={Dataset for the first Global Stocktake}, url={http://gst1.org/}, author={Climate Policy Radar}}
29
+ ```
30
 
31
  ## Fields
32
 
33
+ - `author`: document author (str)
34
+ - `author_is_party`: whether the author is a Party (national government) or not (bool)
35
+ - `block_index`: the index of a text block in a document. Starts from 0 (int)
36
+ - `coords`: coordinates of the text block on the page
37
+ - `date`: publication date of the document
38
+ - `document_content_type`: file type. We have only parsed text from PDFs.
39
+ - `document_id`: unique identifier for a document
40
+ - `document_md5_sum`: md5sum of the document's content
41
+ - `document_name`: document title
42
+ - `document_source_url`: URL for document
43
+ - `document_variant`: used to identify translations. In `[nan, 'Translation', 'Original Language']`
44
+ - `has_valid_text`: our heuristic about whether text is valid or not in the document based on the parser
45
+ - `language`: **FIXME**
46
+ - `languages`: **FIXME**
47
+ - `link`: **FIXME**
48
+ - `page_number`: page number of text block (0-indexed)
49
+ - `text`: text in text block
50
+ - `text_block_id`: identifier for a text block which is unique per document
51
+ - `translated`: whether we have machine-translated the document to English. Where we have translated documents, both the original and translated exist.
52
+ - `type`: **TODO**
53
+ - `type_confidence`: confidence from our parser that the text block is of the labelled type
54
+ - `types`: document types
55
+ - `version`: in `['MAIN', 'ANNEX', 'SUMMARY', 'AMENDMENT', 'SUPPORTING DOCUMENTATION', 'PREVIOUS VERSION']`
56
 
57
+ -
58
  ## Known issues
59
 
60
  * Author names are sometimes corrupted