jcbthnflrs
/

llama381binstruct_summarize_short_merged

@@ -3,199 +3,104 @@ library_name: transformers
 tags:
 - trl
 - sft
 ---
-# 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]

 tags:
 - trl
 - sft
+- summarization
+- legal-ai
 ---
+# Model Card for Legal Document Summarizer
 <!-- Provide a quick summary of what the model is/does. -->
+This model is fine-tuned to convert legal documents into human-readable summaries using Llama 3 8B Instruct as the base model. It was trained using QLoRA/LoRA techniques for efficient fine-tuning.
 ## Model Details
 ### Model Description
+This is a fine-tuned version of NousResearch/Meta-Llama-3-8B-Instruct, optimized for summarizing legal documents in plain English. The model uses Parameter-Efficient Fine-Tuning (PEFT) methods, specifically LoRA, to achieve performance comparable to full fine-tuning while using significantly fewer computational resources.
+- **Developed by:** [Your Username]
+- **Model type:** Causal Language Model (LLaMA 3 Architecture)
+- **Language(s):** English
+- **License:** [Base model license applies]
+- **Finetuned from model:** NousResearch/Meta-Llama-3-8B-Instruct
+### Model Sources
+- **Base Model:** [NousResearch/Meta-Llama-3-8B-Instruct](https://huggingface.co/NousResearch/Meta-Llama-3-8B-Instruct)
+- **Training Code:** Based on LLM Engineering Challenge
 ## Uses
 ### Direct Use
+This model is designed for converting legal documents, terms of service, and other legal content into plain English summaries that are easier for general audiences to understand. It can be used directly through the Hugging Face API or interface.
+### Downstream Use
+The model can be integrated into:
+- Legal document processing systems
+- Terms of service simplification tools
+- Contract analysis applications
+- Legal document management systems
 ### Out-of-Scope Use
+The model should not be used as a replacement for legal advice or professional legal interpretation. It is meant to assist in understanding legal documents but not to provide legal guidance.
 ## Training Details
 ### Training Data
+The model was trained on the Plain English Summary of Contracts dataset, which contains pairs of legal documents (EULA, TOS, etc.) and their natural language summaries. The dataset was split into:
+- Training set: 68 examples
+- Test set: 9 examples
+- Validation set: 8 examples
 ### Training Procedure
+#### Preprocessing
+- Input text is formatted using a specific template following Llama 3's chat format
+- Special tokens are used to mark legal document boundaries
+- Maximum sequence length: 2048 tokens
 #### Training Hyperparameters
+- **Training regime:** 4-bit quantization using QLoRA
+- **Optimizer:** AdamW
+- **Learning rate:** 2e-4
+- **Batch size:** 1 per device
+- **Training steps:** 500
+- **Warmup steps:** 30
+- **Evaluation steps:** 25
+- **Learning rate scheduler:** Linear
+- **LoRA rank (r):** 16
+- **LoRA alpha:** 32
+- **LoRA dropout:** 0.1
+### Hardware and Software
+#### Hardware Requirements
+- GPU: T4 or better
+- Memory: Optimized for consumer-level resources through QLoRA
+#### Software Requirements
+- transformers library
+- PEFT library
+- bitsandbytes for quantization
+- TRL for supervised fine-tuning
 ## Evaluation
+Training metrics show:
+- Starting training loss: ~1.52
+- Final training loss: ~0.0006
+- Final validation loss: ~2.74
+## Model Card Authors
+@jcbthnflrs
 ## Model Card Contact
+https://x.com/jcbthnflrs