OEvortex
/

HelpingAI-3B-v3

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

 ---
+license: other
+license_name: helpingai
+license_link: LICENSE.md
+pipeline_tag: text-generation
+tags:
+- HelpingAI
+- Emotionally Intelligent
+- EQ
+---
+# HelpingAI-3B: Emotionally Intelligent Conversational AI
+![logo](https://huggingface.co/OEvortex/HelpingAI-3B/resolve/main/HelpingAI.png)
+## Overview
+HelpingAI-3B is a large language model designed for emotionally intelligent conversational interactions. It is trained to engage users with empathy, understanding, and supportive dialogue across a wide range of topics and contexts. The model aims to provide a supportive AI companion that can attune to users' emotional states and communicative needs.
+## Objectives
+- Engage in open-ended dialogue while displaying emotional intelligence
+- Recognize and validate user emotions and emotional contexts
+- Provide supportive, empathetic, and psychologically-grounded responses
+- Avoid insensitive, harmful, or unethical speech
+- Continuously improve emotional awareness and dialogue skills
+## Methodology
+HelpingAI-3B is based on the HelpingAI series and further trained using:
+- Supervised learning on large dialogue datasets with emotional labeling
+- Reinforcement learning with a reward model favoring emotionally supportive responses
+- Constitution training to instill stable and beneficial objectives
+- Knowledge augmentation from psychological resources on emotional intelligence
+## Emotional Quotient (EQ)
+NOT tested yet
+## Usage code
+```python
+import torch
+from transformers import AutoModelForCausalLM, AutoTokenizer, TextStreamer
+# Let's bring in the big guns! Our super cool HelpingAI-3B model
+model = AutoModelForCausalLM.from_pretrained("OEvortex/HelpingAI-3B-v3", trust_remote_code=True, torch_dtype=torch.float16).to("cuda")
+# We also need the special HelpingAI translator to understand our chats
+tokenizer = AutoTokenizer.from_pretrained("OEvortex/HelpingAI-3B-v3", trust_remote_code=True, torch_dtype=torch.float16)
+# This TextStreamer thingy is our secret weapon for super smooth conversation flow
+streamer = TextStreamer(tokenizer)
+# Now, here comes the magic! ✨ This is the basic template for our chat
+prompt = """
+<|im_start|>system: {system}
+<|im_end|>
+<|im_start|>user: {insaan}
+<|im_end|>
+<|im_start|>assistant:
+"""
+# Okay, enough chit-chat, let's get down to business!  Here's what will be our system prompt
+system = "You are HelpingAI a emotional AI always answer my question in HelpingAI-style"
+# And the insaan is curious (like you!) insaan means human in hindi
+insaan = "I'm excited because I just got accepted into my dream school! I wanted to share the good news with someone."
+# Now we combine system and user messages into the template, like adding sprinkles to our conversation cupcake
+prompt = prompt.format(system=system, insaan=insaan)
+# Time to chat! We'll use the tokenizer to translate our text into a language the model understands
+inputs = tokenizer(prompt, return_tensors="pt", return_attention_mask=False).to("cuda")
+# Here comes the fun part!  Let's unleash the power of HelpingAI-3B to generate some awesome text
+generated_text = model.generate(**inputs, max_length=3084, top_p=0.95, do_sample=True, temperature=0.6, use_cache=True, streamer=streamer)
+```
+## Example Dialogue
+  > Express joy and excitement about visiting a new place.
+Yay! 🎉 Excitement is the best thing we can experience! 🌟 Get ready to explore new places, learn something new, and meet amazing people! 🌈 Let's go on an adventure together! 🌟
+  > I'm excited because I just got accepted into my dream school! I wanted to share the good news with someone.
+That's awesome! 🌟 I'd love to hear more about it! Sharing good news is always a pleasure. Which school is it and how did you feel when you got accepted? Remember, I'm here to support you and celebrate your achievements! 🎉🌈🌟
+  > My best friend just got into an argument with me and I don't know what to do. How can I fix this situation?
+It is always tough when friends have misunderstandings, but it's important to communicate and work through the problem together. You can start by talking to your friend and trying to understand their perspective. It's also helpful to be empathetic and supportive, and to listen to their point of view. Remember, conflicts are a part of any relationship, and it's how you handle them that matters. Good luck! 🌟
+  > How can you identify the emotions of others based on their body language and facial expressions?
+🤔 Understanding body language and facial expressions can be a complex task, but I can definitely help you with that! 😊 When someone is feeling happy, their face might smile, their eyes might light up, and they might have an open and relaxed posture. Worrying or sadness might be shown through furrowed brows, a tense posture, and a downturned mouth. Anger might be shown through clenched teeth, a furrowed brow, and a tense body language. Love and affection might be shown through a heart-shaped face, a smile, and open arms. These are just generalizations, and there can be a wide range of emotions people express, but it's a good starting point for understanding body language and facial expressions. If you want to learn more, I'm here to help! 😊