FaheemBEG commited on
Commit
ef92d88
·
verified ·
1 Parent(s): 61b39bb

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +10 -8
README.md CHANGED
@@ -32,7 +32,7 @@ The original and full **LEGI** dataset includes:
32
  - All **73 official codes in force**, and **29 repealed codes**.
33
  - And more ...
34
 
35
- In this version, only versions of articles that are currently **in force** (`VIGUEUR`) or **abrogated deferred** (`ABROGE_DIFF`) are included.
36
 
37
  Each article is chunked and vectorized using the [`BAAI/bge-m3`](https://huggingface.co/BAAI/bge-m3) embedding model, enabling use in **semantic search**, **retrieval-augmented generation (RAG)**, and **legal research** systems for example.
38
 
@@ -45,12 +45,13 @@ The dataset is provided in **Parquet format** and includes the following columns
45
  | Column Name | Type | Description |
46
  |---------------------|----------|-----------------------------------------------------------------------------|
47
  | `chunk_id` | `str` | Unique chunk identifier. |
48
- | `cid` | `str` | LEGI article source identifier. |
49
- | `chunk_number` | `int` | Index of the chunk within the article. |
 
50
  | `nature` | `str` | Nature of the text (e.g., `Article`). |
51
  | `category` | `str` | Type of legislative document (e.g., `LOI`, `DECRET`, `ARRETE`, etc.). |
52
  | `ministry` | `str` | Ministry responsible for the publication, if applicable. |
53
- | `status` | `str` | Status of the article: `VIGUEUR` (in force) or `ABROGE_DIFF` (abrogated deferred).|
54
  | `title` | `str` | Short title of the legislative document. |
55
  | `full_title` | `str` | Full formal title of the text. |
56
  | `subtitles` | `str` | Subtitle(s) indicating article grouping or section. |
@@ -70,12 +71,13 @@ The dataset is provided in **Parquet format** and includes the following columns
70
  The following fields were extracted and/or transformed from the original source:
71
 
72
  - **Basic fields**:
73
- - `cid`, `nature`, `category`, ,`ministry`,`status`, `title`, `full_title`, `subtitles`, `number`, and `start_date`, `end_date` are extracted directly from the metadata of each article.
74
 
75
  - **Generated fields**:
76
- - `chunk_id`: a generated unique identifier combining the `cid` and `chunk_number`.
77
- - `chunk_number`: index of the chunk from the original decision.
78
-
 
79
  - **Textual fields**:
80
  - `nota`: additional notes, also directly extracted from metadatas.
81
  - `text`: chunk of the main text content.
 
32
  - All **73 official codes in force**, and **29 repealed codes**.
33
  - And more ...
34
 
35
+ In this version, only versions of articles that are currently **in force** (`VIGUEUR`), **modified** from their original in force version ('MODIFIE') or **abrogated deferred** (`ABROGE_DIFF`) are included.
36
 
37
  Each article is chunked and vectorized using the [`BAAI/bge-m3`](https://huggingface.co/BAAI/bge-m3) embedding model, enabling use in **semantic search**, **retrieval-augmented generation (RAG)**, and **legal research** systems for example.
38
 
 
45
  | Column Name | Type | Description |
46
  |---------------------|----------|-----------------------------------------------------------------------------|
47
  | `chunk_id` | `str` | Unique chunk identifier. |
48
+ | `doc_id` | `str` | LEGI article source identifier. |
49
+ | `chunk_index` | `int` | Index of the chunk within its original document. Starting from 1. |
50
+ | `chunk_xxh64` | `str` | XXH64 hash of the `chunk_text` value. |
51
  | `nature` | `str` | Nature of the text (e.g., `Article`). |
52
  | `category` | `str` | Type of legislative document (e.g., `LOI`, `DECRET`, `ARRETE`, etc.). |
53
  | `ministry` | `str` | Ministry responsible for the publication, if applicable. |
54
+ | `status` | `str` | Status of the article: `VIGUEUR` (in force), 'MODIFIE' (modified) or `ABROGE_DIFF` (abrogated deferred).|
55
  | `title` | `str` | Short title of the legislative document. |
56
  | `full_title` | `str` | Full formal title of the text. |
57
  | `subtitles` | `str` | Subtitle(s) indicating article grouping or section. |
 
71
  The following fields were extracted and/or transformed from the original source:
72
 
73
  - **Basic fields**:
74
+ - `doc_id`, `nature`, `category`, ,`ministry`,`status`, `title`, `full_title`, `subtitles`, `number`, and `start_date`, `end_date` are extracted directly from the metadata of each article.
75
 
76
  - **Generated fields**:
77
+ - `chunk_id`: a generated unique identifier of the chunk, combining the `doc_id` and `chunk_index`.
78
+ - `chunk_index`: is the index of the chunk of a same article. Each article has an unique `doc_id`.
79
+ - `chunk_xxh64`: is the xxh64 hash of the `chunk_text` value. It is useful to determine if the `chunk_text` value has changed from a version to another.
80
+
81
  - **Textual fields**:
82
  - `nota`: additional notes, also directly extracted from metadatas.
83
  - `text`: chunk of the main text content.