Create README.md

README.md

@@ -0,0 +1,89 @@
+---
+license: other
+license_name: hsul
+license_link: https://huggingface.co/OEvortex/vortex-3b/raw/main/LICENSE.md
+pipeline_tag: text-generation
+tags:
+- HelpingAI
+- Emotionally Intelligent
+---
+
+
+# HelpingAI-9B: Emotionally Intelligent Conversational AI
+
+![logo](https://huggingface.co/OEvortex/HelpingAI-3B/resolve/main/HelpingAI.png)
+
+## Overview
+HelpingAI-9B 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-9B 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
+
+## Usage code
+```python
+from transformers import AutoModelForCausalLM, AutoTokenizer
+import torch
+device = "cuda" # the device to load the model onto
+
+model = AutoModelForCausalLM.from_pretrained(
+    "OEvortex/HelpingAI-9B",
+    torch_dtype='auto',
+    device_map="auto"
+)
+tokenizer = AutoTokenizer.from_pretrained("OEvortex/HelpingAI-9B")
+
+prompt = "Express joy and excitement about visiting a new place"
+messages = [
+    # {"role": "system", "content": "You are a helpful AI assistant."},
+    {"role": "user", "content": prompt}
+]
+text = tokenizer.apply_chat_template(
+    messages,
+    tokenize=False,
+    add_generation_prompt=True
+)
+model_inputs = tokenizer([text], return_tensors="pt").to(device)
+
+generated_ids = model.generate(
+    model_inputs.input_ids,
+    max_new_tokens=1024,
+    eos_token_id=tokenizer.eos_token_id,
+    temperature=0.25,
+)
+generated_ids = [
+    output_ids[len(input_ids):] for input_ids, output_ids in zip(model_inputs.input_ids, generated_ids)
+]
+
+response = tokenizer.batch_decode(generated_ids)[0]
+print(response)
+
+```
+
+## Example Dialogue
+Human: Express joy and excitement about visiting a new place.
+
+HelpingAI-9B: Yay! 🎉 I'm so excited to visit a new place! 😊 The thought of exploring and discovering new things fills me with joy and anticipation. I can't wait to take in the sights, sounds, and flavors of this new place. Let's make the most of this adventure! 🌟 How about you? Are you excited too? 😊
+
+Human: I'm feeling really down today. Nothing seems to be going right.
+
+HelpingAI-9B: I'm really sorry to hear that you're feeling down. It's okay to have bad days, and it's important to reach out for support when you need it. If you want to talk about what's been bothering you, I'm here to listen and offer support. Remember, you're not alone, and things will get better.
+
+Human: I'm excited because I just got accepted into my dream school! I wanted to share the good news with someone.
+
+HelpingAI-9B: 🎉 That's amazing! I'm so happy for you! 🌟 Congratulations on achieving your dream and getting accepted into your dream school! This is such a special moment, and I'm here to celebrate with you! 🌈 Keep shining, and remember to always believe in yourself!
+
+Human: My best friend just got into an argument with me and I don't know what to do. How can I fix this situation?
+
+HelpingAI-9B: Hey there! 😊 It's totally normal to have disagreements with friends. To fix this situation, try to approach the conversation with empathy and understanding. Let your friend know that you care about their feelings and that you're willing to work things out. Communication is key, so be open and honest about how you're feeling. It's important to listen to each other and find a solution that works for both of you. Good luck! 🌟
+