Update README.md

README.md

@@ -1,47 +1,74 @@
-## Dataset: Swiss Legislation
-
-### Description
-This dataset contains legislation texts in five languages: 
-- German _(17,559 entries)_
-- French _(11,197 entries)_
-- Italian _(6,201 entries)_
-- Romansh _(534 entries)_
-- English _(207 entries)_
+---
+license: cc-by-sa-4.0
+task_categories:
+- text-classification
+- translation
+language:
+- de
+- fr
+- it
+pretty_name: Swiss Legislation
+size_categories:
+- 100K<n<1M
+---
+
+# Dataset Card for Swiss Legislation
+
+## Table of Contents
+- [Table of Contents](#table-of-contents)
+- [Dataset Description](#dataset-description)
+  - [Dataset Summary](#dataset-summary)
+  - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
+  - [Languages](#languages)
+- [Dataset Structure](#dataset-structure)
+  - [Data Instances](#data-instances)
+  - [Data Fields](#data-fields)
+  - [Data Splits](#data-splits)
+- [Dataset Creation](#dataset-creation)
+  - [Curation Rationale](#curation-rationale)
+  - [Source Data](#source-data)
+  - [Annotations](#annotations)
+  - [Personal and Sensitive Information](#personal-and-sensitive-information)
+- [Considerations for Using the Data](#considerations-for-using-the-data)
+  - [Social Impact of Dataset](#social-impact-of-dataset)
+  - [Discussion of Biases](#discussion-of-biases)
+  - [Other Known Limitations](#other-known-limitations)
+- [Additional Information](#additional-information)
+  - [Dataset Curators](#dataset-curators)
+  - [Licensing Information](#licensing-information)
+  - [Citation Information](#citation-information)
+  - [Contributions](#contributions)
+
+## Dataset Description
+
+- **Homepage:**
+- **Repository:**
+- **Paper:**
+- **Leaderboard:**
+- **Point of Contact:**
+
+### Dataset Summary
+
+Swiss Citation Extraction is a multilingual, diachronic dataset of 36K Swiss laws. This dataset is part of a challenging Information Retreival task.
+### Supported Tasks and Leaderboards
+
+### Languages
   
 The total number of texts in the dataset is 35,698. The dataset is saved in _lexfind_v2.jsonl_ format.
+Switzerland has four official languages German, French, Italian and Romanch with some additional English laws being represenated. Laws are written by legal experts.
+36K    & 18K      & 11K  & 6K  & 534 & 207
+| Language   | Subset     | Number of Documents  | 
+|------------|------------|----------------------|  
+| German     | **de**     | 18K                  |
+| French     | **fr**     | 11K                  |
+| Italian    | **it**     | 6K                   |
+| Romanch    | **rm**     | 534                  |
+| English    | **en**     | 207                  |
 
-### Canton Distribution
-1. 'ch': Switzerland (Federal) - 15840
-2. 'fr': Fribourg - 1633
-3. 'be': Bern - 1344
-4. 'vs': Valais - 1328
-5. 'gr': Graubünden - 1205
-6. 'ne': Neuchâtel - 1115
-7. 'zh': Zurich - 974
-8. 'bs': Basel-Stadt - 899
-9. 'bl': Basel-Landschaft - 863
-10. 'vd': Vaud - 870
-11. 'ge': Geneva - 837
-12. 'sg': St. Gallen - 764
-13. 'ju': Jura - 804
-14. 'zg': Zug - 632
-15. 'ti': Ticino - 627
-16. 'lu': Lucerne - 584
-17. 'so': Solothurn - 547
-18. 'ow': Obwalden - 513
-19. 'ik': Interkantonal - 510
-20. 'sh': Schaffhausen - 469
-21. 'gl': Glarus - 467
-22. 'tg': Thurgau - 453
-23. 'sz': Schwyz - 423
-24. 'ai': Appenzell Innerrhoden - 416
-25. 'ag': Aargau - 483
-26. 'ar': Appenzell Ausserrhoden - 330
-27. 'nw': Nidwalden - 401
-28. 'ur': Uri - 367
+## Dataset Structure
 
+### Data Fields
 
-### Data
 Each entry in the dataset is a dictionary with the following keys:
 - `canton`: the canton of origin of the legislation
   - example: "ag"
@@ -82,6 +109,86 @@ Each entry in the dataset is a dictionary with the following keys:
 - `quotes`: a list of quotes from the legislation
   - example: []
 
-### Splits
-There is only one split in this dataset, which contains all the legislation texts.
+### Data Instances
+[More Information Needed]
+### Data Fields
+[More Information Needed]
+### Data Splits
+
+1. 'ch': Switzerland (Federal) - 15840
+2. 'fr': Fribourg - 1633
+3. 'be': Bern - 1344
+4. 'vs': Valais - 1328
+5. 'gr': Graubünden - 1205
+6. 'ne': Neuchâtel - 1115
+7. 'zh': Zurich - 974
+8. 'bs': Basel-Stadt - 899
+9. 'bl': Basel-Landschaft - 863
+10. 'vd': Vaud - 870
+11. 'ge': Geneva - 837
+12. 'sg': St. Gallen - 764
+13. 'ju': Jura - 804
+14. 'zg': Zug - 632
+15. 'ti': Ticino - 627
+16. 'lu': Lucerne - 584
+17. 'so': Solothurn - 547
+18. 'ow': Obwalden - 513
+19. 'ik': Interkantonal - 510
+20. 'sh': Schaffhausen - 469
+21. 'gl': Glarus - 467
+22. 'tg': Thurgau - 453
+23. 'sz': Schwyz - 423
+24. 'ai': Appenzell Innerrhoden - 416
+25. 'ag': Aargau - 483
+26. 'ar': Appenzell Ausserrhoden - 330
+27. 'nw': Nidwalden - 401
+28. 'ur': Uri - 367
+29. 
+## Dataset Creation
+### Curation Rationale
+### Source Data
+#### Initial Data Collection and Normalization
+
+The original data are published from the Swiss Federal Supreme Court (https://www.bger.ch) in unprocessed formats (HTML). The documents were downloaded from the Entscheidsuche portal (https://entscheidsuche.ch) in HTML. 
+
+#### Who are the source language producers?
+
+The decisions are written by the judges and clerks in the language of the proceedings.
+
+### Annotations
+#### Annotation process
+
+#### Who are the annotators?
+
+Metadata is published by the Swiss Federal Supreme Court (https://www.bger.ch).
+
+### Personal and Sensitive Information
+
+The dataset contains publicly available court decisions from the Swiss Federal Supreme Court. Personal or sensitive information has been anonymized by the court before publication according to the following guidelines: https://www.bger.ch/home/juridiction/anonymisierungsregeln.html.
+
+## Considerations for Using the Data
+### Social Impact of Dataset
+[More Information Needed]
+### Discussion of Biases
+[More Information Needed]
+### Other Known Limitations
+[More Information Needed]
+## Additional Information
+### Dataset Curators
+[More Information Needed]
+### Licensing Information
+
+We release the data under CC-BY-4.0 which complies with the court licensing (https://www.bger.ch/files/live/sites/bger/files/pdf/de/urteilsveroeffentlichung_d.pdf)
+© Swiss Federal Supreme Court, 2002-2022
+
+The copyright for the editorial content of this website and the consolidated texts, which is owned by the Swiss Federal Supreme Court, is licensed under the Creative Commons Attribution 4.0 International licence. This means that you can re-use the content provided you acknowledge the source and indicate any changes you have made.
+Source: https://www.bger.ch/files/live/sites/bger/files/pdf/de/urteilsveroeffentlichung_d.pdf
+
+### Citation Information
 
+*Visu, Ronja, Joel*
+*Title: Blabliblablu*
+*Name of conference*
+```
+cit
+```