Update README.md

README.md

@@ -1,3 +1,135 @@
----
-license: apache-2.0
----
+---
+configs:
+- config_name: default
+  data_files:
+  - split: fr
+    path: data/fr-*
+license: cc-by-4.0
+task_categories:
+- question-answering
+- text-generation
+- table-question-answering
+language:
+- fr
+tags:
+- legal
+- droit
+- fiscalité
+- taxation
+- δεξιά
+- recht
+- derecho
+pretty_name: The case-law, centralizing legal decisions for better use
+---
+## Dataset Description
+- **Repository:** https://huggingface.co/datasets/HFforLegal/case-law
+- **Leaderboard:** N/A
+- **Point of Contact:** [Louis Brulé Naudet](mailto:louisbrulenaudet@icloud.com)
+  
+# The Case-law, centralizing legal decisions for better use, a community Dataset.
+
+The Case-law Dataset is a comprehensive collection of legal decisons from various countries, centralized in a common format. This dataset aims to improve the development of legal AI models by providing a standardized, easily accessible corpus of global legal documents.
+
+<div class="not-prose bg-gradient-to-r from-gray-50-to-white text-gray-900 border" style="border-radius: 8px; padding: 0.5rem 1rem;">
+    <p>Join us in our mission to make AI more accessible and understandable for the legal world, ensuring that the power of language models can be harnessed effectively and ethically in the pursuit of justice.</p>
+</div>
+
+## Objective
+
+The primary objective of this dataset is to centralize laws from around the world in a common format, thereby facilitating:
+
+1. Comparative legal studies
+2. Development of multilingual legal AI models
+3. Cross-jurisdictional legal research
+4. Improvement of legal technology tools
+
+By providing a standardized dataset of global legal texts, we aim to accelerate the development of AI models in the legal domain, enabling more accurate and comprehensive legal analysis across different jurisdictions.
+
+Easy-to-use script for hashing the `document`:
+
+```python
+import hashlib
+import datasets
+
+def hash(
+  text: str
+) -> str:
+    """
+    Create or update the hash of the document content.
+
+    This function takes a text input, converts it to a string, encodes it in UTF-8, 
+    and then generates a SHA-256 hash of the encoded text.
+
+    Parameters
+    ----------
+    text : str
+        The text content to be hashed.
+
+    Returns
+    -------
+    str
+        The SHA-256 hash of the input text, represented as a hexadecimal string.
+    """
+    return hashlib.sha256(str(text).encode()).hexdigest()
+
+dataset = dataset.map(lambda x: {"hash": hash(x["document"])})
+```
+
+## Country-based Splits
+
+The dataset uses country-based splits to organize legal documents from different jurisdictions. Each split is identified by the ISO 3166-1 alpha-2 code of the corresponding country.
+
+### ISO 3166-1 alpha-2 Codes
+
+ISO 3166-1 alpha-2 codes are two-letter country codes defined in ISO 3166-1, part of the ISO 3166 standard published by the International Organization for Standardization (ISO).
+
+Some examples of ISO 3166-1 alpha-2 codes:
+- France: fr
+- United States: us
+- United Kingdom: gb
+- Germany: de
+- Japan: jp
+- Brazil: br
+- Australia: au
+
+Before submitting a new split, please make sure the proposed split fits within the ISO code for the related country. 
+
+### Accessing Country-specific Data
+
+To access legal documents for a specific country, you can use the country's ISO 3166-1 alpha-2 code as the split name when loading the dataset. Here's an example:
+
+```python
+from datasets import load_dataset
+
+# Load the entire dataset
+dataset = load_dataset("HFforLegal/case-law")
+
+# Access the French legal decisions
+fr_dataset = dataset['fr']
+```
+
+## Ethical Considerations
+
+While this dataset provides a valuable resource for legal AI development, users should be aware of the following ethical considerations:
+
+- Privacy: Ensure that all personal information has been properly anonymized.
+- Bias: Be aware of potential biases in the source material and in the selection of included laws.
+- Currency: Laws change over time. Always verify that you're working with the most up-to-date version of a law for any real-world application.
+- Jurisdiction: Legal interpretations can vary by jurisdiction. AI models trained on this data should not be used as a substitute for professional legal advice.
+
+## Citing & Authors
+
+If you use this dataset in your research, please use the following BibTeX entry.
+
+```BibTeX
+@misc{HFforLegal2024,
+  author =       {Louis Brulé Naudet},
+  title =        {The case-law, centralizing legal decisions for better use},
+  year =         {2024}
+  howpublished = {\url{https://huggingface.co/datasets/HFforLegal/case-law}},
+}
+```
+
+## Feedback
+
+If you have any feedback, please reach out at [louisbrulenaudet@icloud.com](mailto:louisbrulenaudet@icloud.com).