Update README.md to enhance model card for Biden Mistral Adapter with detailed descriptions, technical specifications, and usage guidelines.

README.md

@@ -1,202 +1,173 @@
 ---
 base_model: mistralai/Mistral-7B-Instruct-v0.2
 library_name: peft
+language:
+- en
+tags:
+- mistral
+- lora
+- adapter
+- fine-tuned
+- politics
+- conversational
+license: mit
+datasets:
+- rohanrao/joe-biden-tweets
+- christianlillelund/joe-biden-2020-dnc-speech
 ---
 
-# Model Card for Model ID
+<div align="center">
 
-<!-- Provide a quick summary of what the model is/does. -->
+# 🇺🇸 Biden Mistral Adapter 🇺🇸
 
+**A finely-tuned Mistral adapter that captures the distinctive voice, speaking style, and rhetoric of President Joe Biden**
 
+</div>
 
-## Model Details
-
-### Model Description
-
-<!-- Provide a longer summary of what this model is. -->
-
-
-
-- **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 -->
+## 📋 Model Overview 
 
-[More Information Needed]
+This LoRA adapter for [Mistral-7B-Instruct-v0.2](https://huggingface.co/mistralai/Mistral-7B-Instruct-v0.2) has been crafted to emulate Joe Biden's unique communication patterns, discourse style, and policy framing.
 
-## Environmental Impact
+### ⚙️ Technical Specifications
 
-<!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
+|   **Feature**   |                     **Details**                    |
+|:---------------:|:--------------------------------------------------:|
+| Base Model      | mistralai/Mistral-7B-Instruct-v0.2                 |
+| Adapter Type    | LoRA (Low-Rank Adaptation)                         |
+| LoRA Rank       | 16                                                 |
+| Primary Language| English                                            |
+| Special Feature | Merged weights from style and identity LoRA adapters|
 
-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]
+## 🔄 Model Evolution
 
-## Technical Specifications [optional]
+This enhanced version combines two carefully balanced adapter components:
 
-### Model Architecture and Objective
+- 🎭 **Style Adapter**: The original Biden-style adapter (nnat03/biden-mistral-adapter)
+- 🧠 **Identity Adapter**: Custom identity adapter (biden-identity-adapter)
 
-[More Information Needed]
+This merged approach produces more coherent and contextually appropriate responses while preserving Biden's characteristic voice, rhetorical patterns, and speaking cadence.
 
-### Compute Infrastructure
+---
 
-[More Information Needed]
+## 🎯 Intended Applications
 
-#### Hardware
+- 🎓 **Educational**: Research on political discourse and communication styles
+- 🔍 **Analytical**: Interactive simulations for rhetoric analysis 
+- 🎨 **Creative**: Content development exploring political communication
 
-[More Information Needed]
+---
 
-#### Software
+## 📚 Training Data
 
-[More Information Needed]
+The model was fine-tuned on two comprehensive datasets:
 
-## Citation [optional]
+- 📱 **Biden Twitter Archive** ([2007-2020](https://www.kaggle.com/datasets/rohanrao/joe-biden-tweets)): Capturing everyday communication style
+- 🎤 **DNC Acceptance Speech** ([2020](https://www.kaggle.com/datasets/christianlillelund/joe-biden-2020-dnc-speech)): Formal oratorical patterns
 
-<!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
+---
 
-**BibTeX:**
+## 🛠️ Training Process
+
+### 🔧 Technical Framework
+- **Libraries**: Hugging Face Transformers and PEFT
+- **Optimization**: 4-bit quantization for efficiency
+
+### 🔍 LoRA Configuration
+```
+r=16
+lora_alpha=64
+lora_dropout=0.05
+```
+
+### 🎛️ Target Modules
+- q_proj, k_proj, v_proj, o_proj
+- gate_proj, up_proj, down_proj
+
+### ⚗️ Training Parameters
+| **Parameter** | **Value** |
+|:------------:|:---------:|
+| Batch Size | 4 |
+| Gradient Accumulation | 4 |
+| Learning Rate | 2e-4 |
+| Epochs | 3 |
+| LR Scheduler | cosine |
+| Optimizer | paged_adamw_8bit |
+| Precision | BF16 |
 
-[More Information Needed]
+---
 
-**APA:**
+## ⚠️ Limitations and Considerations
 
-[More Information Needed]
+- 🎭 This model mimics a speaking style but may not provide factually accurate information
+- 🗣️ While it emulates Biden's rhetoric, it does not represent his actual views
+- 🔄 The model may reproduce biases present in the training data
+- 📊 Not suitable for production applications without RAG enhancement for factual accuracy
 
-## Glossary [optional]
+---
 
-<!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
+## 💻 Implementation Guide
+
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer, BitsAndBytesConfig
+from peft import PeftModel
+import torch
+
+# Load base model with 4-bit quantization
+base_model_id = "mistralai/Mistral-7B-Instruct-v0.2"
+bnb_config = BitsAndBytesConfig(
+    load_in_4bit=True,
+    bnb_4bit_compute_dtype=torch.float16,
+    bnb_4bit_quant_type="nf4",
+    bnb_4bit_use_double_quant=True,
+)
+
+# Load model and tokenizer
+model = AutoModelForCausalLM.from_pretrained(
+    base_model_id,
+    quantization_config=bnb_config,
+    device_map="auto", 
+    torch_dtype=torch.float16
+)
+tokenizer = AutoTokenizer.from_pretrained(base_model_id)
+
+# Apply the adapter
+model = PeftModel.from_pretrained(model, "nnat03/biden-mistral-adapter")
+
+# Generate a response
+prompt = "What's your vision for America's future?"
+input_text = f"<s>[INST] {prompt} [/INST]"
+inputs = tokenizer(input_text, return_tensors="pt").to("cuda")
+outputs = model.generate(**inputs, max_length=512, temperature=0.7, do_sample=True)
+response = tokenizer.decode(outputs[0], skip_special_tokens=True)
+print(response.split("[/INST]")[-1].strip())
+```
 
-[More Information Needed]
+---
 
-## More Information [optional]
+## 📝 Citation
 
-[More Information Needed]
+```bibtex
+@misc{nnat03-biden-mistral-adapter,
+  author = {nnat03},
+  title = {Biden Mistral Adapter},
+  year = {2023},
+  publisher = {Hugging Face},
+  howpublished = {\url{https://huggingface.co/nnat03/biden-mistral-adapter}}
+}
+```
 
-## Model Card Authors [optional]
+---
 
-[More Information Needed]
+## 🔍 Ethical Usage
 
-## Model Card Contact
+This model is intended for educational and research purposes only. It mimics the speaking style of a public figure but does not represent their actual views or statements. Please use responsibly.
 
-[More Information Needed]
-### Framework versions
+---
 
-- PEFT 0.15.0
+<div align="center">
+<b>Framework version:</b> PEFT 0.15.0
+</div>