Update README.md

README.md

@@ -52,7 +52,8 @@ task_ids: []
 
 ## Dataset Summary
 
-This dataset contains an implementation of occlusion for the SwissJudgmentPrediction task.
+This dataset contains an implementation of occlusion for the SwissJudgmentPrediction task. 
+Note that this dataset set only provides a test set and should be used in comination with the [Swiss-Judgment-Prediction](https://huggingface.co/datasets/swiss_judgment_prediction) dataset.
 
 ### Documents
 Occlusion-Swiss-Judgment-Prediction is a subset of the [Swiss-Judgment-Prediction](https://huggingface.co/datasets/swiss_judgment_prediction) dataset.
@@ -70,83 +71,47 @@ Switzerland has four official languages with 3 languages (German, French and Ita
 ### Data Instances
 #### Multilingual use of the dataset
 
-When the dataset is used in a multilingual setting selecting the the 'all_languages' flag:
-
-```python
-from datasets import load_dataset
-dataset = load_dataset('occlusion_swiss_judgment_prediction', 'all_languages')
-
-```
-
-
-For occlusion:
-
-```json
-{
-  "id": 57542,
-  "year": 2017,
-  "label": "dismissal",
-  "language": "de",
-  "region": "Espace_Mittelland",
-  "canton": "BE",
-  "legal_area": "social_law",
-  "explainability_label": "Supports judgment",
-  "occluded_text": "Mit Entscheid vom 4. Mai 2017 hiess das Verwaltungsgericht des Kantons Bern die Beschwerde teilweise gut, hob die angefochtene Verf\u00fcgung auf und wies die Sache an die IV-Stelle zur\u00fcck, damit sie, nach Vornahme der Abkl\u00e4rungen im Sinne der Erw\u00e4gungen, \u00fcber den Rentenanspruch neu verf\u00fcge",
-  "text": "Sachverhalt: A. Die 1987 geborene, aus Bolivien stammende A.A._ leidet an einer pr\u00e4natalen Retinopathie und einer dadurch bedingten schweren Sehbehinderung beidseits. Im Dezember 2003 reiste sie in die Schweiz ein. Im Mai 2007 verheiratete sie sich mit B.A._. Am 22. Juni 2007 meldete sie sich bei der Invalidenversicherung zum Leistungsbezug an. Am 6. Februar 2008 lehnte die IV-Stelle Bern das Leistungsgesuch verf\u00fcgungsweise ab, weil die versicherungsm\u00e4ssigen Voraussetzungen nicht erf\u00fcllt seien. Am 22. Oktober 2009 stellte die Versicherte ein neues Leistungsgesuch, auf welches die IV-Stelle mit Verf\u00fcgung vom 16. Dezember 2009 nicht e**int**rat. Am 27. Juli 2010 meldete sich A.A._ erneut bei der Invalidenversicherung zum Leistungsbezug an, wobei sie eine Verschlechterung der Sehkraft geltend machte. Mit Verf\u00fcgung vom 10. November 2010 sprach ihr die IV-Stelle ab 1. August 2010 eine Entsch\u00e4digung f\u00fcr leichte Hilflosigkeit zu. Soweit das Gesuch den Invalidenrentenanspruch betraf, trat die IV-Stelle darauf nicht ein (Verf\u00fcgung vom 19. November 2010). Im Juli 2011 erteilte die IV-Stelle Kostengutsprache f\u00fcr berufliche Eingliederungsmassnahmen, welche die Versicherte vorzeitig abbrach. Mit Verf\u00fcgung vom 27. Januar 2016 er\u00f6ffnete die IV-Stelle der Versicherten, dass sie keinen Anspruch auf eine Invalidenrente habe. Der Versicherungsfall sei bereits vor der Einreise in die Schweiz eingetreten. B. A.A._ liess Beschwerde einreichen mit dem Rechtsbegehren, unter Aufhebung der Verf\u00fcgung vom 27. Januar 2016 sei ihr eine ausserordentliche Invalidenrente zuzusprechen.  . C. Die IV-Stelle f\u00fchrt Beschwerde in \u00f6ffentlich-rechtlichen Angelegenheiten mit dem Antrag, der vorinstanzliche Entscheid sei aufzuheben. "
-}
-
-```
-
-#### Monolingual use of the dataset
-
-When the dataset is used in a monolingual setting selecting the ISO language code for one of the 3 supported languages. For example:
-
-```python
-from datasets import load_dataset
-dataset = load_dataset('occlusion_swiss_judgment_prediction', 'de_1')
-```
-For occlusion:
-
-```json
-{
-  "id": 57542,
-  "year": 2017,
-  "label": "dismissal",
-  "language": "de",
-  "region": "Espace_Mittelland",
-  "canton": "BE",
-  "legal_area": "social_law",
-  "explainability_label": "Supports judgment",
-  "occluded_text": "Mit Entscheid vom 4. Mai 2017 hiess das Verwaltungsgericht des Kantons Bern die Beschwerde teilweise gut, hob die angefochtene Verf\u00fcgung auf und wies die Sache an die IV-Stelle zur\u00fcck, damit sie, nach Vornahme der Abkl\u00e4rungen im Sinne der Erw\u00e4gungen, \u00fcber den Rentenanspruch neu verf\u00fcge",
-  "text": "Sachverhalt: A. Die 1987 geborene, aus Bolivien stammende A.A._ leidet an einer pr\u00e4natalen Retinopathie und einer dadurch bedingten schweren Sehbehinderung beidseits. Im Dezember 2003 reiste sie in die Schweiz ein. Im Mai 2007 verheiratete sie sich mit B.A._. Am 22. Juni 2007 meldete sie sich bei der Invalidenversicherung zum Leistungsbezug an. Am 6. Februar 2008 lehnte die IV-Stelle Bern das Leistungsgesuch verf\u00fcgungsweise ab, weil die versicherungsm\u00e4ssigen Voraussetzungen nicht erf\u00fcllt seien. Am 22. Oktober 2009 stellte die Versicherte ein neues Leistungsgesuch, auf welches die IV-Stelle mit Verf\u00fcgung vom 16. Dezember 2009 nicht e**int**rat. Am 27. Juli 2010 meldete sich A.A._ erneut bei der Invalidenversicherung zum Leistungsbezug an, wobei sie eine Verschlechterung der Sehkraft geltend machte. Mit Verf\u00fcgung vom 10. November 2010 sprach ihr die IV-Stelle ab 1. August 2010 eine Entsch\u00e4digung f\u00fcr leichte Hilflosigkeit zu. Soweit das Gesuch den Invalidenrentenanspruch betraf, trat die IV-Stelle darauf nicht ein (Verf\u00fcgung vom 19. November 2010). Im Juli 2011 erteilte die IV-Stelle Kostengutsprache f\u00fcr berufliche Eingliederungsmassnahmen, welche die Versicherte vorzeitig abbrach. Mit Verf\u00fcgung vom 27. Januar 2016 er\u00f6ffnete die IV-Stelle der Versicherten, dass sie keinen Anspruch auf eine Invalidenrente habe. Der Versicherungsfall sei bereits vor der Einreise in die Schweiz eingetreten. B. A.A._ liess Beschwerde einreichen mit dem Rechtsbegehren, unter Aufhebung der Verf\u00fcgung vom 27. Januar 2016 sei ihr eine ausserordentliche Invalidenrente zuzusprechen.  . C. Die IV-Stelle f\u00fchrt Beschwerde in \u00f6ffentlich-rechtlichen Angelegenheiten mit dem Antrag, der vorinstanzliche Entscheid sei aufzuheben. "
-}
-
-```
 
 ### Data Fields
 
 The following data fields are provided for documents (train, validation):
 
 id: (**int**) a unique identifier of the for 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
 
 The following data fields are provided for documents (occ_test):
 
 id: (**int**) a unique identifier of the for the document
+
 year: (**int**) the publication year
+
 label: (**str**) the judgment outcome: dismissal or 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
+
 explainability_label (**str**): the explainability label assigned to the occluded text: Supports judgment, Opposes judgment, Neutral, Baseline
+
 occluded_text (**str**): the occluded text
+
 text: (**str**) the facts of the case w/o the occluded text except for cases w/ explainability label "Baseline" (contain entire facts)
 
 Note that Baseline cases are only contained in version 1 of the occlusion test set, since they do not change from experiment to experiment.