avinashhm
/

dolly-3b-lora

@@ -1,199 +1,108 @@
 ---
 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]

 ---
 library_name: transformers
+tags:
+  - dolly-v2
+  - instruction-tuning
+  - peft
+  - lora
 ---
+# Model Card for dolly-3b-lora
+This model is a fine-tuned version of the Dolly V2 3B language model, enhanced with Parameter-Efficient Fine-Tuning (PEFT) using Low-Rank Adaptation (LoRA). It was fine-tuned on the LaMini-instruction dataset to improve its ability to follow instructions and generate coherent responses for various tasks.
 ## Model Details
 ### Model Description
+This is a fine-tuned version of the `databricks/dolly-v2-3b` model, adapted using LoRA on the LaMini-instruction dataset. The model is designed for instruction-following tasks, leveraging the efficiency of LoRA to fine-tune approximately 2.93% of the total parameters while maintaining performance. It supports text generation tasks and has been optimized for use on GPU hardware with 8-bit quantization, with a fallback to CPU if needed.
+- **Developed by:** avinashhm
+- **Funded by [optional]:** Not specified
+- **Shared by [optional]:** avinashhm
+- **Model type:** Causal Language Model
+- **Language(s) (NLP):** English
+- **License:** Apache-2.0
+- **Finetuned from model [optional]:** databricks/dolly-v2-3b
+### Model Sources
+- **Repository:** https://huggingface.co/avinashhm/dolly-3b-lora
 ## Uses
 ### Direct Use
+The model is intended for direct use in text generation tasks, particularly for instruction-following scenarios such as answering questions, generating lists, or writing short narratives. It can be used by developers, researchers, or hobbyists working on natural language processing applications.
 ### Downstream Use [optional]
+The model can be further fine-tuned for specific tasks, such as chatbots, virtual assistants, or specialized text generation applications. It can be integrated into larger ecosystems requiring instruction-based text generation.
 ### Out-of-Scope Use
+The model is not designed for real-time, safety-critical applications or tasks requiring factual accuracy without verification, as it may generate incorrect or biased responses. It should not be used for malicious purposes, such as generating harmful content or misinformation.
 ## Bias, Risks, and Limitations
+The model inherits biases from the LaMini-instruction dataset and the base Dolly V2 3B model. It may produce biased, incomplete, or factually incorrect responses, particularly for sensitive topics. Performance is limited by the small fine-tuning dataset (200 samples) and LoRA configuration, which may not generalize well to all instruction types. Some responses may lack depth or coherence for complex tasks due to limited training data and epochs.
 ### Recommendations
+Users should verify outputs for accuracy and appropriateness, especially in sensitive applications. Further fine-tuning with a larger, more diverse dataset could improve performance and reduce biases. Caution is advised when deploying in public-facing applications to avoid unintended consequences from biased or harmful outputs.
 ## How to Get Started with the Model
+Use the code below to get started with the model:
+```python
+import torch
+from transformers import AutoTokenizer, AutoModelForCausalLM, pipeline
+from peft import PeftModel
+# Model names
+base_model_name = "databricks/dolly-v2-3b"
+peft_model_name = "avinashhm/dolly-3b-lora"
+# Load Tokenizer
+tokenizer = AutoTokenizer.from_pretrained(base_model_name)
+# Load Base Model
+base_model = AutoModelForCausalLM.from_pretrained(
+    base_model_name,
+    torch_dtype=torch.float16,
+    device_map="auto"
+)
+# Load PEFT (LoRA) Adapter
+model = PeftModel.from_pretrained(
+    base_model,
+    peft_model_name,
+    torch_dtype=torch.float16
+)
+# Merge adapter weights into base model (optional, improves speed)
+model = model.merge_and_unload()
+# Define prompt template
+prompt_template = """Below is an instruction that describes a task. Write a response that appropriately completes the request. Instruction: {instruction}\n Response:"""
+# Create Text Generation Pipeline
+inf_pipeline = pipeline(
+    "text-generation",
+    model=model,
+    tokenizer=tokenizer,
+    max_new_tokens=256,
+    pad_token_id=tokenizer.eos_token_id,
+    truncation=True,
+    do_sample=True,
+    temperature=0.7,
+    top_p=0.95,
+    repetition_penalty=1.1
+)
+# Example prompt
+prompt = "List 5 reasons why someone should learn to cook."
+formatted_prompt = prompt_template.format(instruction=prompt)
+response = inf_pipeline(formatted_prompt)[0]['generated_text'].split(" Response:")[-1].strip()
+print(response)