daqc
/

kuntur-peru-legal-es-gemma-2b-it-merged

@@ -1,199 +1,202 @@
 ---
 library_name: transformers
-tags: []
 ---
-# Model Card for Model ID
-<!-- Provide a quick summary of what the model is/does. -->
-## Model Details
-### Model Description
-<!-- Provide a longer summary of what this model is. -->
-This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
-- **Developed by:** [More Information Needed]
-- **Funded by [optional]:** [More Information Needed]
-- **Shared by [optional]:** [More Information Needed]
-- **Model type:** [More Information Needed]
-- **Language(s) (NLP):** [More Information Needed]
-- **License:** [More Information Needed]
-- **Finetuned from model [optional]:** [More Information Needed]
-### Model Sources [optional]
-<!-- Provide the basic links for the model. -->
-- **Repository:** [More Information Needed]
-- **Paper [optional]:** [More Information Needed]
-- **Demo [optional]:** [More Information Needed]
-## Uses
-<!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
-### Direct Use
-<!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
-[More Information Needed]
-### Downstream Use [optional]
-<!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
-[More Information Needed]
-### Out-of-Scope Use
-<!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
-[More Information Needed]
-## Bias, Risks, and Limitations
-<!-- This section is meant to convey both technical and sociotechnical limitations. -->
-[More Information Needed]
-### Recommendations
-<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
-Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
-## How to Get Started with the Model
-Use the code below to get started with the model.
-[More Information Needed]
-## Training Details
-### Training Data
-<!-- This should link to a Dataset Card, perhaps with a short stub of information on what the training data is all about as well as documentation related to data pre-processing or additional filtering. -->
-[More Information Needed]
-### Training Procedure
-<!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
-#### Preprocessing [optional]
-[More Information Needed]
-#### Training Hyperparameters
-- **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
-#### Speeds, Sizes, Times [optional]
-<!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
-[More Information Needed]
-## Evaluation
-<!-- This section describes the evaluation protocols and provides the results. -->
-### Testing Data, Factors & Metrics
-#### Testing Data
-<!-- This should link to a Dataset Card if possible. -->
-[More Information Needed]
-#### Factors
-<!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
-[More Information Needed]
-#### Metrics
-<!-- These are the evaluation metrics being used, ideally with a description of why. -->
-[More Information Needed]
-### Results
-[More Information Needed]
-#### Summary
-## Model Examination [optional]
-<!-- Relevant interpretability work for the model goes here -->
-[More Information Needed]
-## Environmental Impact
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
-Carbon emissions can be estimated using the [Machine Learning Impact calculator](https://mlco2.github.io/impact#compute) presented in [Lacoste et al. (2019)](https://arxiv.org/abs/1910.09700).
-- **Hardware Type:** [More Information Needed]
-- **Hours used:** [More Information Needed]
-- **Cloud Provider:** [More Information Needed]
-- **Compute Region:** [More Information Needed]
-- **Carbon Emitted:** [More Information Needed]
-## Technical Specifications [optional]
-### Model Architecture and Objective
-[More Information Needed]
-### Compute Infrastructure
-[More Information Needed]
-#### Hardware
-[More Information Needed]
-#### Software
-[More Information Needed]
-## Citation [optional]
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
-**BibTeX:**
-[More Information Needed]
-**APA:**
-[More Information Needed]
-## Glossary [optional]
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
-[More Information Needed]
-## More Information [optional]
-[More Information Needed]
-## Model Card Authors [optional]
-[More Information Needed]
-## Model Card Contact
-[More Information Needed]

 ---
+language:
+- es
+license: apache-2.0
 library_name: transformers
+tags:
+- Legal
+- Law
+- Peru
+- Leyes Juridicas
+datasets:
+- somosnlp/constitucion-politica-del-peru-1993-qa-gemma-2b-it-format
+- daqc/constitucion-politica-del-peru-1993-qa
+widget:
+- text: 'Una mujer es víctima de violencia de género y busca protección legal. ¿Qué
+    debo hacer y bajo qué base legal debería actuar?
+    '
+- text: 'Un ciudadano es arrestado sin que se le informen sus derechos. ¿Qué capítulo
+    y artículo de la Constitución del Perú establece los derechos fundamentales de
+    las personas detenidas y las garantías procesales que deben respetarse durante
+    su arresto?
+    '
+- text: 'Me gustaría solicitar asistencia legal gratuita en Perú. ¿Podrías proporcionarme
+    los pasos necesarios para llevar a cabo este proceso?
+    '
+- text: ¿Qué artículo de la Constitución Política del Perú establece que toda persona
+    tiene derecho a la vida, a su identidad, a su integridad moral, psíquica y física,
+    y a su libre desarrollo y bienestar?
 ---
+# Model Card for kuntur-peru-legal-es-gemma-2b-it-merged ⚖️
+<p align="center">
+  <img src="https://cdn-uploads.huggingface.co/production/uploads/64461026e1fd8d65b27e6187/bUbvGpmsKC7YsJs4aBt7T.jpeg" alt="Model Illustration" width="300">
+</p>
+## Gemma-2B-IT-Peru-Legal-ES
+The Gemma-2B-IT-Peru-Legal-ES model is a state-of-the-art language model fine-tuned specifically for legal text comprehension and generation tasks in Spanish, focusing on the legal context of the Peruvian Constitution. Leveraging advanced techniques such as Low-Rank Adaptation (LoRA) and Bits and Bytes Quantization (BNB), this model provides accurate and contextually relevant responses to legal queries, making it a valuable tool for legal professionals, researchers, and AI enthusiasts interested in the legal domain.
+## Table of Contents
+- [kuntur-peru-legal-es-gemma-2b-it-merged ⚖️](#kuntur-peru-legal-es-gemma-2b-it-merged)
+    + [Model Description 📘](#model-description)
+  * [Finetuning Progress 🛠️](#finetuning-progress)
+    + [Recommendations 📝](#recommendations-)
+  * [How to Get Started with the Model 🚀](#how-to-get-started-with-the-model)
+  * [Training Dataset 🧠](#training-dataset)
+  * [Finetuning Progress 🤖](#finetuning-progress)
+  *
+    + [Environment and Libraries 🖥️](#environment-and-libraries)
+    + [QLoRA Configuration 🧮](#qlora-configuration)
+    + [Model Merging and Saving 💾](#model-merging-and-saving)
+  * [Logging with Wandb 📊](#logging-with-wandb)
+  * [Impacto Ambiental 🌳](#impacto-ambiental)
+## Model Description
+kuntur-peru-legal-es-gemma-2b-it-merged  is a contextual legal language model designed to provide personalized legal advice in Spanish based on Peruvian legal texts. Leveraging advanced techniques like LoRA, the model offers accurate and contextually relevant responses to legal queries, covering various aspects of Peruvian law and regulation. Whether it's understanding rights, navigating legal procedures, or interpreting statutes, kuntur-peru-legal-es-gemma-2b-it-merged empowers users with comprehensive and reliable legal guidance tailored to the Peruvian legal landscape.
+- **Developed by:** [Alonso Quispe](https://huggingface.co/daqc)
+- **Model type:** Causal Language Model, specially fine-tuned with LoRA for the distinct domain of Peruvian law and regulation.
+- **Language(s) (NLP):** Spanish, tailored for the legal and regulatory context of Peru.
+- **License:** Apache License. This open-source license ensures that the model can be freely used, modified, and distributed. Please check the model's page on Hugging Face for specific licensing details.
+- **Base model:** google/gemma-2b-it`
+## Recommendations
+Users should verify model outputs against current regulations and consult with professionals for critical applications. Awareness of the model's scope and limitations is crucial for effective use.
+# How to Get Started with the Model
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+# Cargar el modelo y el tokenizador
+model_name = "somosnlp/kuntur-peru-legal-es-gemma-2b-it-merged"
+model = AutoModelForCausalLM.from_pretrained(model_name)
+tokenizer = AutoTokenizer.from_pretrained(model_name)
+# Ejemplo de uso
+input_text = "Una persona ha sido despedida de su trabajo injustamente y necesita entender cuáles son sus derechos laborales según la Constitución Política del Perú."
+input_ids = tokenizer.encode(input_text, return_tensors="pt")
+output = model.generate(input_ids, max_length=100, num_return_sequences=1, temperature=0.7)
+print(tokenizer.decode(output[0], skip_special_tokens=True))
+```
+## Training Dataset
+The kuntur-peru-legal-es-gemma-2b-it-merged model was fine-tuned exclusively on the "[Constitución Política del Perú](https://huggingface.co/datasets/daqc/constitucion-politica-del-peru-1993-qa) dataset available through Hugging Face Datasets. This dataset serves as a rich source of questions and answers pertaining to the legal framework outlined in the Peruvian Constitution.
+The dataset encompasses a wide range of topics and provisions within the Peruvian Constitution, providing comprehensive coverage of constitutional principles, rights, and legal interpretations.
+## Finetuning Progress
+<p align="center">
+  <img src="https://cdn-uploads.huggingface.co/production/uploads/64461026e1fd8d65b27e6187/N8VAkUIuWK0vgYZRlmwew.png" alt="Loss Function Graph" width="900">
+</p>
+---
+## Environment and Libraries
+The training process was executed within a Python environment, utilizing essential libraries to facilitate various tasks:
+- **transformers:** Used for loading and fine-tuning the model, providing a seamless interface for working with pre-trained language models.
+- **datasets:** Employed for efficient handling and preprocessing of the training dataset, ensuring streamlined data pipelines.
+- **torch:** Utilized as the primary deep learning framework to support model training and optimization.
+- **peft:** Integrated for applying Low-Rank Adaptation (LoRA) techniques to the model, enabling efficient adaptation to specialized domains without compromising performance.
+- **qlora:** Additionally utilized for further model adaptation, enhancing its ability to comprehend and generate responses specific to the legal context of the "Constitucióm Política del Perú" dataset.
+## QLoRA Configuration
+QLoRA (Quantization LoRA) was employed to optimize the model's computational efficiency and memory footprint while preserving its accuracy. Two configurations were utilized:
+- **BitsAndBytesConfig:** This configuration enabled the model to load in 4-bit quantization, leveraging the nf4 quantization type with a torch.bfloat16 compute data type for enhanced efficiency during inference.
+    ```python
+        bnb_config = BitsAndBytesConfig(
+        load_in_4bit=True,
+        bnb_4bit_quant_type="nf4",
+        bnb_4bit_compute_dtype=torch.bfloat16,
+        bnb_4bit_use_double_quant=False,
+    )
+    ```
+- **LoRAConfig:** This configuration applied Low-Rank Adaptation (LoRA) to the model, optimizing its parameters for the specific task of language modeling in the legal domain. Key parameters include:
+    - **r:** Reduced to 8 from the default 32, controlling the rank of adaptation layers.
+    - **lora_alpha:** Adjusted to 16 from the default 64, regulating the sparsity of adapted weights.
+    - **target_modules:** Specified modules for adaptation, focusing on query, key, value, and output projection layers.
+    - **bias:** Set to "none" to exclude bias terms from adaptation, simplifying the model architecture.
+    - **lora_dropout:** Reduced to 0.025 from the default 0.05, controlling the dropout rate during adaptation.
+    - **task_type:** Configured as "CAUSAL_LM" to indicate the task type of the language model.
+    -
+    ```python
+        config = LoraConfig(
+        r=8,
+        lora_alpha=16,
+        target_modules=['q_proj', 'k_proj', 'v_proj', 'o_proj'],
+        bias="none",
+        lora_dropout=0.025,
+        task_type="CAUSAL_LM",
+    )
+    ```
+These configurations were crucial for optimizing the model's performance and resource utilization during training and inference, ensuring efficient deployment.
+## Model Merging and Saving 💾
+After fine-tuning, the LoRA-adjusted weights were merged back with the base Gemma model to create the final kuntur-peru-legal-es-gemma-2b-it-merged. The model was then saved and made available through Hugging Face for easy access and further development.
+## Logging with Wandb 📊
+During the training process, Wandb (Weights & Biases) was used for comprehensive logging and visualization of key metrics. Wandb's powerful tracking capabilities enabled real-time monitoring of training progress, evaluation metrics, and model performance. Through interactive dashboards and visualizations, Wandb facilitated deep insights into the training dynamics, allowing for efficient model optimization and debugging. This logging integration with Wandb enhances transparency, reproducibility, and collaboration among researchers and practitioners.
+## Impacto Ambiental 🌳
+The training of `kuntur-peru-legal-es-gemma-2b-it-merged` was conducted optimizing the computational expenditure required.
+- **Hardware Type:** A10G-24GB
+- **Hours Utilized:** Approximately 3.5 hours
+- **Energy Consumption:** Approximately --- kWh
+- **Estimated CO2 Emissions:** Approximately --- kg
+## To-Do List
+## Dataset Generation, Human Feedback Review with Argilla, and Finetuning with the Following Legal Texts:
+| **Dataset Generation** | **Human Feedback Review with Argilla** | **Model Finetuning** |
+|-----------|-----------|-----------|
+| ☑️ Constitution of Peru | ☑️ Constitution of Peru | ☑️ Constitution of Peru |
+| 🔲 Penal Code | 🔲 Penal Code | 🔲 Penal Code |
+| 🔲 Congress Regulation | 🔲 Congress Regulation | 🔲 Congress Regulation |
+| 🔲 New Constitutional Procedural Code | 🔲 New Constitutional Procedural Code | 🔲 New Constitutional Procedural Code |
+| 🔲 Civil Code | 🔲 Civil Code | 🔲 Civil Code |
+| 🔲 (TUO) Civil Procedural Code | 🔲 (TUO) Civil Procedural Code | 🔲 (TUO) Civil Procedural Code |
+| 🔲 Penal Procedural Code (D.L 638) | 🔲 Penal Procedural Code (D.L 638) | 🔲 Penal Procedural Code (D.L 638) |
+| 🔲 New Penal Procedural Code (D.L 957) | 🔲 New Penal Procedural Code (D.L 957) | 🔲 New Penal Procedural Code (D.L 957) |
+| 🔲 Penal Execution Code | 🔲 Penal Execution Code | 🔲 Penal Execution Code |
+| 🔲 Military Police Penal Code | 🔲 Military Police Penal Code | 🔲 Military Police Penal Code |
+| 🔲 Military Police Justice Code | 🔲 Military Police Justice Code | 🔲 Military Police Justice Code |
+| 🔲 Children and Adolescents Code | 🔲 Children and Adolescents Code | 🔲 Children and Adolescents Code |
+| 🔲 Adolescent Penal Responsibility Code | 🔲 Adolescent Penal Responsibility Code | 🔲 Adolescent Penal Responsibility Code |
+| 🔲 Commercial Code | 🔲 Commercial Code | 🔲 Commercial Code |
+| 🔲 Consumer Protection and Defense Code | 🔲 Consumer Protection and Defense Code | 🔲 Consumer Protection and Defense Code |
+| 🔲 Tax Code (TUO) | 🔲 Tax Code (TUO) | 🔲 Tax Code (TUO) |
+| 🔲 Criminal Procedure Code | 🔲 Criminal Procedure Code | 🔲 Criminal Procedure Code |
+## License
+This project is distributed under the Apache 2.0 license.