multieurlex all-level fix

README.md

@@ -81,7 +81,7 @@ task_ids:
 
 ## Dataset Description
 
-- **Repository: https://git.rwth-aachen.de/johanna.frenz/legalglue**
+- **Repository:** https://git.rwth-aachen.de/johanna.frenz/legalglue
 
 ### Dataset Summary
 
@@ -102,7 +102,7 @@ It consists of four already existing datasets covering three task types and a to
 </table>
 
 ### Languages
-
+see Split section
 
 ## Dataset Structure
 
@@ -112,6 +112,11 @@ It consists of four already existing datasets covering three task types and a to
 
 German_LER example
 
+```python
+from datasets import load_dataset
+dataset = load_dataset('jfrenz/legalglue', 'german_ler')
+```
+
 ```json
 {
   'id': '66722',
@@ -124,6 +129,12 @@ German_LER example
 
 LeNER-Br example
 
+```python
+from datasets import load_dataset
+dataset = load_dataset('jfrenz/legalglue', 'lener_br')
+```
+
+
 ```json
 {
   'id': '7826',
@@ -135,6 +146,11 @@ LeNER-Br example
 
 swissJudgmentPrediction_de example
 
+```python
+from datasets import load_dataset
+dataset = load_dataset('jfrenz/legalglue', 'swissJudgmentPrediction_de')
+```
+
 ```json
 {
   'id': 48755,
@@ -150,7 +166,13 @@ swissJudgmentPrediction_de example
 
 ####MultiEURLEX
 
-Monolingual example out of the MultiEURLEX-Datase
+Monolingual example out of the MultiEURLEX-Dataset
+
+```python
+from datasets import load_dataset
+dataset = load_dataset('jfrenz/legalglue', 'multi_eurlex_de')
+```
+
 
 ```json
 {
@@ -160,6 +182,12 @@ Monolingual example out of the MultiEURLEX-Datase
 ```
 
 Multilingual example out of the MultiEURLEX-Dataset
+
+```python
+from datasets import load_dataset
+dataset = load_dataset('jfrenz/legalglue', 'multi_eurlex_all_languages')
+```
+
 ```json
 {
   'celex_id': '32002R0130',
@@ -177,18 +205,59 @@ Multilingual example out of the MultiEURLEX-Dataset
 ```
 ### Data Fields
 
-[More Information Needed]
+####German_LER
+
+- `id`: id of the sample
+- `tokens`: the tokens of the sample text
+- `ner_tags`: the NER tags of each token
+
+
+####LeNER_Br
+
+- `id`: id of the sample
+- `tokens`: the tokens of the sample text
+- `ner_tags`: the NER tags of each token
+
+####SwissJudgmentPrediction
+
+-`id`: (**int**) ID of the document
+-`year`: (**int**) the publication year
+-`text`: (**str**) the facts of the case
+-`label`: (**class label**) the judgment outcome: 0 (dismissal) or 1 (approval)
+-`language`: (**str**) one of (de, fr, it)
+-`region`: (**str**) the region of the lower court
+-`canton`: (**str**) the canton of the lower court
+-`legal area`: (**str**) the legal area of the case
+
+
+####MultiEURLEX
+
+Monolingual use:
+-`celex_id`: (**str**)  Official Document ID of the document
+-`text`: (**str**)  An EU Law
+-`labels`: (**List[int]**) List of relevant EUROVOC concepts (labels)
+
+Multilingual use:
+-`celex_id`: (**str**)  Official Document ID of the document
+-`text`: (dict[**str**])  A dictionary with the 23 languages as keys and the corresponding EU Law as values.\
+-`labels`: (**List[int]**) List of relevant EUROVOC concepts (labels)
+
+The labels lists consists per default of level 1 EUROVOC concepts. Can be changed by adding the label_level parameter when loading the dataset. (available levels: level_1, level_2, level_3, all_levels)
+```python
+from datasets import load_dataset
+dataset = load_dataset('jfrenz/legalglue', 'multi_eurlex_de', label_level="level_3")
+```
 
 ### Data Splits
 
 <table>
 <tr><th>Dataset</th><th> Language </th> <th>   ISO code </th> <th>   Number of Documents train/dev/test </th> </tr>
-<tr><td>German-LER</td><td> German </td> <td>  de </td> <td>  66723 / - / -  </td> </tr>
-<tr><td>LeNER-Br</td><td> Portuguese </td> <td>   pt </td> <td>   7828 / 1177 / 1390 </td> </tr>
-<tr><td rowspan="3">SwissJudgmentPrediction</td><td> German </td> <td>  <b>de</b>   </td> <td>  35458 / 4705 / 9725 </td> </tr>
-<tr><td> French </td> <td>  <b>fr</b>   </td> <td>  21179 / 3095 / 6820 </td> </tr>
-<tr><td> Italian </td> <td>  <b>it</b>   </td> <td>  3072 / 408 / 812 </td> </tr>
-<tr><td rowspan="23">MultiEURLEX</td><td> English     </td> <td>  <b>en</b>   </td> <td>  55,000 / 5,000 / 5,000 </td> </tr>
+<tr><td>German-LER</td><td> German </td> <td><b>de</b></td> <td>  66723 / - / -  </td> </tr>
+<tr><td>LeNER-Br</td><td> Portuguese </td> <td><b>pt</b></td> <td>   7828 / 1177 / 1390 </td> </tr>
+<tr><td rowspan="3">SwissJudgmentPrediction</td><td>German </td> <td><b>de</b></td> <td>  35458 / 4705 / 9725 </td> </tr>
+<tr><td> French </td> <td><b>fr</b></td> <td>  21179 / 3095 / 6820 </td> </tr>
+<tr><td> Italian </td> <td><b>it</b></td> <td>  3072 / 408 / 812 </td> </tr>
+<tr><td rowspan="23">MultiEURLEX</td><td> English     </td> <td><b>en</b></td> <td>  55,000 / 5,000 / 5,000 </td> </tr>
 <tr><td> German      </td> <td>  <b>de</b>   </td> <td> 55,000 / 5,000 / 5,000 </td> </tr>
 <tr><td> French      </td> <td>  <b>fr</b>   </td> <td> 55,000 / 5,000 / 5,000 </td> </tr>
 <tr><td> Italian     </td> <td>  <b>it</b>   </td> <td>  55,000 / 5,000 / 5,000 </td> </tr>

legalglue.py

@@ -833,7 +833,7 @@ EUROVOC_CONCEPTS = {
         "2825",
         "5781",
     ],
-    "original": [
+    "all_levels": [
         "100149",
         "100160",
         "100148",