kdutia commited on
Commit
d81908c
1 Parent(s): c7c6366

Update readme with document families and instructions for getting unique text blocks (#2)

Browse files

- Update readme with document families and instructions for getting unique text blocks (25b40956e2e2e7cd82aaf2c88bc1a95a03f83b5f)

Files changed (1) hide show
  1. README.md +16 -1
README.md CHANGED
@@ -58,6 +58,19 @@ We currently only parse text out of PDFs. Any non-PDF file will only be referenc
58
 
59
  We have yet to process approximately 150 documents of the 1700 documents due to formatting issues. We are working on resolving this issue as soon as possible. [See the document list here](https://labs.climatepolicyradar.org/global-stocktake/UNPROCESSED_DOCUMENTS.html).
60
 
 
 
 
 
 
 
 
 
 
 
 
 
 
61
  ## Field descriptions
62
 
63
  - `author`: document author (str)
@@ -67,6 +80,8 @@ We have yet to process approximately 150 documents of the 1700 documents due to
67
  - `date`: publication date of the document
68
  - `document_content_type`: file type. We have only parsed text from PDFs.
69
  - `document_id`: unique identifier for a document
 
 
70
  - `document_md5_sum`: md5sum of the document's content
71
  - `document_name`: document title
72
  - `document_source_url`: URL for document
@@ -85,7 +100,7 @@ We have yet to process approximately 150 documents of the 1700 documents due to
85
  ## Known issues
86
 
87
  * Author names are sometimes corrupted
88
- * Text blocks in non-English languages are currently missing or marked as `nan`
89
 
90
  ## Usage in Python
91
 
 
58
 
59
  We have yet to process approximately 150 documents of the 1700 documents due to formatting issues. We are working on resolving this issue as soon as possible. [See the document list here](https://labs.climatepolicyradar.org/global-stocktake/UNPROCESSED_DOCUMENTS.html).
60
 
61
+ ## Data model
62
+
63
+ This dataset contains individual documents that are grouped into 'document families'.
64
+
65
+ The way to think of is as follows:
66
+
67
+ * Each row in the dataset is a physical document. A physical document is a single document, in any format.
68
+ * All physical documents belong to document families. A document family is one or more physical documents, centred around a main document, which jointly contain all relevant information about the main document. For example, where a document has a translation, amendments or annexes, those files are stored together as a family.
69
+
70
+ ### Getting unique text blocks
71
+
72
+ > TODO
73
+
74
  ## Field descriptions
75
 
76
  - `author`: document author (str)
 
80
  - `date`: publication date of the document
81
  - `document_content_type`: file type. We have only parsed text from PDFs.
82
  - `document_id`: unique identifier for a document
83
+ - `document_family_id`: see *data model* section above
84
+ - `document_family_slug`: see *data model* section above
85
  - `document_md5_sum`: md5sum of the document's content
86
  - `document_name`: document title
87
  - `document_source_url`: URL for document
 
100
  ## Known issues
101
 
102
  * Author names are sometimes corrupted
103
+ * Text block languages are sometimes missing or marked as `nan`
104
 
105
  ## Usage in Python
106