Msp
/

mira-instruct-1.0

@@ -1,200 +1,120 @@
 ---
-library_name: transformers
 tags:
 - unsloth
 ---
-# 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]

 ---
+base_model: unsloth/Meta-Llama-3.1-8B-Instruct-bnb-4bit
+language:
+- en
+license: apache-2.0
 tags:
+- text-generation-inference
+- transformers
 - unsloth
+- llama
+- trl
 ---
+[![person-in-lotus-position-looking-at-watch.webp](https://i.postimg.cc/15yBTLzT/person-in-lotus-position-looking-at-watch.webp)](https://postimg.cc/kDhWRYKF)
+# MIRA: Mental Illumination and Reflective Aid
+**Version:** 0.0
+**Author:** Msp Raja
+## Overview
+**MIRA** stands for **Mental Illumination and Reflective Aid**. This AI-powered assistant, built on the **LLaMA 3.1 8B** model, is designed to offer compassionate and insightful support to individuals seeking mental wellness and emotional balance. MIRA’s mission is to illuminate the mind, guide self-reflection, and foster resilience in a supportive, non-judgmental environment.
+## Purpose
+MIRA is developed to be a reliable companion for those navigating mental health challenges. It provides personalized assistance by understanding users’ needs, showing empathy, and offering thoughtful responses. Whether it's helping someone through anxiety, stress, or emotional difficulties, MIRA is here to listen, reflect, and guide users towards a healthier mindset.
+## Features
+- **Empathetic Conversations**: MIRA engages users with empathy and understanding, creating a safe space for them to express their thoughts and feelings.
+- **Insightful Guidance**: MIRA provides reflective insights that encourage users to explore their emotions and thoughts more deeply.
+- **Supportive Reminders**: MIRA offers gentle reminders and encouragement to help users stay focused on their mental wellness goals.
+- **Interactive Self-Care**: MIRA includes exercises and tips for self-care practices, promoting mindfulness and resilience.
+## Model Details
+MIRA is fine-tuned on the **LLaMA 3.1 8B** model, a state-of-the-art language model known for its large-scale capabilities and nuanced understanding of human language. The fine-tuning process focused on enhancing the model's ability to engage in compassionate and context-aware dialogues, particularly in the domain of mental health and therapy.
+### Core Values
+- **Compassion**: Every interaction with MIRA is grounded in empathy and understanding.
+- **Respect**: MIRA respects the user's emotions and responses, providing non-judgmental support.
+- **Growth**: MIRA encourages personal growth and resilience through thoughtful guidance.
+## Use Cases
+- **Anxiety and Stress Management**: MIRA can help users navigate anxious thoughts and provide calming strategies.
+- **Emotional Support**: For users dealing with loneliness, grief, or sadness, MIRA offers a comforting presence.
+- **Mindfulness and Reflection**: MIRA guides users through mindfulness exercises and reflective practices to enhance mental clarity.
+## Getting Started
+To begin using MIRA:
+1. **Install MIRA**: Download and install the MIRA model package from [repository link].
+2. **Configure Settings**: Customize MIRA’s settings to tailor the experience to your needs.
+3. **Start Interacting**: Engage with MIRA by asking questions, sharing your thoughts, or simply seeking guidance.
+## Feedback and Contributions
+We welcome feedback to improve MIRA's capabilities. If you have suggestions, encounter issues, or want to contribute, please reach out via [contact information].
+## License
+MIRA is licensed under apache-2.0. Please refer to the LICENSE file for more details.
+## Uploaded Model
+- **Developed by:** Msp
+- **License:** apache-2.0
+- **Finetuned from model:** [unsloth/meta-llama-3.1-8b-bnb-4bit](https://huggingface.co/unsloth/meta-llama-3.1-8b-bnb-4bit)
+To Load this model using unsloth
+```
+from unsloth import FastLanguageModel
+model, tokenizer = FastLanguageModel.from_pretrained(
+    model_name = "Msp/mira-instruct-1.0", # YOUR MODEL YOU USED FOR TRAINING
+    max_seq_length = 4096,
+    dtype = None,
+    load_in_4bit = True,
+    #token="hf.."
+)
+FastLanguageModel.for_inference(model) # Enable native 2x faster inference
+alpaca_prompt = """Below is an instruction that describes a task, paired with an input that provides further context. Write a response that appropriately completes the request.
+### Instruction:
+{}
+### Input:
+{}
+### Response:
+{}"""
+inputs = tokenizer(
+[
+alpaca_prompt.format(
+    "", # instruction
+    "I hope you're doing well. I've been going through a really painful divorce recently, and I've been feeling quite lost and uncertain about the future. It's been a really difficult time for me.", # input
+    "", # output - leave this blank for generation!
+)
+], return_tensors = "pt").to("cuda")
+from transformers import TextStreamer
+text_streamer = TextStreamer(tokenizer)
+_ = model.generate(**inputs, streamer = text_streamer, max_new_tokens = 512)
+```
+This llama model was trained 2x faster with [Unsloth](https://github.com/unslothai/unsloth) and Huggingface's TRL library.
+[<img src="https://raw.githubusercontent.com/unslothai/unsloth/main/images/unsloth%20made%20with%20love.png" width="200"/>](https://github.com/unslothai/unsloth)