louisbrulenaudet commited on
Commit
1b30c5c
1 Parent(s): 04c281f

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +21 -8
README.md CHANGED
@@ -67,14 +67,27 @@ By providing a standardized dataset of global legal texts, we aim to accelerate
67
 
68
  ## Dataset Structure
69
 
70
- The dataset is organized with the following columns:
71
-
72
- - `book`: The name or code of the law book (e.g., "Civil Code", "Penal Code")
73
- - `document`: The full text content of the legal document
74
- - `timestamp`: The timestamp of when the law was enacted or last updated
75
- - `id`: A identifier for each document
76
- - `hash`: A SHA-256 hash of the `document` for verification purposes
77
-
 
 
 
 
 
 
 
 
 
 
 
 
 
78
  Easy-to-use script for hashing the `document`:
79
 
80
  ```python
 
67
 
68
  ## Dataset Structure
69
 
70
+ # Dataset Structure
71
+
72
+ The dataset contains the following columns:
73
+
74
+ 1. **jurisdiction**: Capitalized ISO 3166-1 alpha-2 code representing the country or jurisdiction. This column is useful when stacking data from different jurisdictions.
75
+ 2. **language**: Non-capitalized ISO 639-1 code representing the language of the document. This is particularly useful for multilingual jurisdictions.
76
+ 3. **text**: The main textual content of the document.
77
+ 4. **html**: An HTML-structured version of the text. This may include additional structure such as XML (Akoma Ntoso).
78
+ 5. **title_main**: The primary title of the document. This replaces the 'book' column, as many modern laws are not structured or referred to as 'books'.
79
+ 6. **title_alternative**: A list of official and non-official (nickname) titles for the document.
80
+ 7. **id_sub**: Identifier for lower granularity items within the document, such as specific article numbers. This replaces the 'id' column.
81
+ 8. **id_main**: Document identifier for the main document, such as the European Legislation Identifier (ELI).
82
+ 9. **url_sourcepage**: The source URL of the web page where the document is published.
83
+ 10. **url_sourcefile**: The source URL of the document file (e.g., PDF file).
84
+ 11. **date_publication**: The date when the document was published.
85
+ 12. **date_signature**: The date when the document was signed.
86
+ 13. **uuid**: A universally unique identifier for each row in the dataset.
87
+ 14. **text_hash**: A SHA-256 hash of the 'text' column, useful for verifying data integrity.
88
+ 15. **formatted_date**: The publication date formatted as 'YYYY-MM-DD HH:MM:SS', derived from the 'date_publication' column.
89
+
90
+ This structure ensures comprehensive metadata for each legal document, facilitating easier data management, cross-referencing, and analysis across different jurisdictions and languages.
91
  Easy-to-use script for hashing the `document`:
92
 
93
  ```python