Create README.md
Browse files
README.md
ADDED
@@ -0,0 +1,121 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
---
|
2 |
+
license: other
|
3 |
+
license_name: helpingai
|
4 |
+
license_link: https://helpingai.co/license
|
5 |
+
pipeline_tag: text-generation
|
6 |
+
language:
|
7 |
+
- en
|
8 |
+
tags:
|
9 |
+
- HelpingAI
|
10 |
+
- SER
|
11 |
+
- Emotional Reasoning
|
12 |
+
- Conversational AI
|
13 |
+
- Affective Computing
|
14 |
+
library_name: transformers
|
15 |
+
---
|
16 |
+
|
17 |
+
<div align="center">
|
18 |
+
❤️ <span style="background: linear-gradient(45deg, #FF6347, #FFD700); -webkit-background-clip: text; -webkit-text-fill-color: transparent;">HAI-SER</span>
|
19 |
+
</div>
|
20 |
+
|
21 |
+
<div align="center" style="display: flex; justify-content: center; gap: 4px;">
|
22 |
+
<a href="https://github.com/HelpingAI"><img src="https://img.shields.io/badge/GitHub-Organization-blue.svg" alt="GitHub Organization"></a>
|
23 |
+
<a href="https://huggingface.co/HelpingAI"><img src="https://img.shields.io/badge/🤗%20Hugging%20Face-Organization-yellow" alt="Hugging Face"></a>
|
24 |
+
<a href="https://helpingai.co/license"><img src="https://img.shields.io/badge/License-HelpingAI-green.svg" alt="Model License"></a>
|
25 |
+
<a href="https://github.com/HelpingAI/community/discussions"><img src="https://img.shields.io/badge/Join-Community%20Discussion-blue?style=for-the-badge&logo=github" alt="Join Community Discussion"></a>
|
26 |
+
</div>
|
27 |
+
|
28 |
+
<div align="center">
|
29 |
+
[📜 License](https://helpingai.co/license) | [🌐 Website](https://helpingai.co)
|
30 |
+
</div>
|
31 |
+
|
32 |
+
<div align="center" style="display: flex; justify-content: center; gap: 4px;">
|
33 |
+
<img src="https://img.shields.io/badge/Model%20Type-SER-ff6347" alt="Model Type">
|
34 |
+
<img src="https://img.shields.io/badge/Task-Emotional%20Reasoning-blue" alt="Task">
|
35 |
+
<img src="https://img.shields.io/badge/Version-v1.0-yellow" alt="Version">
|
36 |
+
</div>
|
37 |
+
|
38 |
+
## 🌟 About HAI-SER
|
39 |
+
|
40 |
+
**HAI-SER** is HelpingAI's revolutionary **Structured Emotional Reasoning (SER) model**, crafted to redefine the emotional intelligence of AI. Unlike traditional models, **HAI-SER goes beyond words**—it understands emotions, breaks down mental states, and offers **real, empathetic insights** for human-AI interaction. 🚀
|
41 |
+
|
42 |
+
### 💡 Core Features of HAI-SER
|
43 |
+
|
44 |
+
The **Structured Emotional Reasoning (SER) framework** is built upon these key pillars:
|
45 |
+
|
46 |
+
- **Emotional Vibe Check** – Reads emotional energy from conversations 🎭
|
47 |
+
- **Mind-State Analysis** – Understands thoughts, moods, and mental shifts 🧠
|
48 |
+
- **Root Cause Deep-Dive** – Identifies why emotions arise 🔍
|
49 |
+
- **Impact Check** – Evaluates how emotions affect real-life actions 💥
|
50 |
+
- **Safety Check** – Prioritizes user well-being 🚨
|
51 |
+
- **Healing Game Plan** – Offers structured support for growth & recovery 💪
|
52 |
+
- **Growth Potential** – Helps users evolve emotionally 📈
|
53 |
+
- **How to Approach** – Guides users in communication & self-awareness 🤝
|
54 |
+
|
55 |
+
## 🚀 Implementation
|
56 |
+
|
57 |
+
### Load HAI-SER with Hugging Face Transformers
|
58 |
+
|
59 |
+
```python
|
60 |
+
from transformers import AutoModelForCausalLM, AutoTokenizer
|
61 |
+
|
62 |
+
# Load HAI-SER
|
63 |
+
model = AutoModelForCausalLM.from_pretrained("HelpingAI/HAI-SER")
|
64 |
+
tokenizer = AutoTokenizer.from_pretrained("HelpingAI/HAI-SER")
|
65 |
+
|
66 |
+
# Example usage
|
67 |
+
chat = [
|
68 |
+
{"role": "system", "content": "You are an emotionally intelligent AI assistant who always thinks step by step before responding."},
|
69 |
+
{"role": "user", "content": "I feel really stressed out about my exams."}
|
70 |
+
]
|
71 |
+
|
72 |
+
inputs = tokenizer.apply_chat_template(
|
73 |
+
chat,
|
74 |
+
add_generation_prompt=True,
|
75 |
+
return_tensors="pt"
|
76 |
+
)
|
77 |
+
|
78 |
+
outputs = model.generate(
|
79 |
+
inputs,
|
80 |
+
max_new_tokens=128,
|
81 |
+
temperature=0.7,
|
82 |
+
top_p=0.9,
|
83 |
+
)
|
84 |
+
|
85 |
+
print(tokenizer.decode(outputs[0], skip_special_tokens=True))
|
86 |
+
```
|
87 |
+
|
88 |
+
## ⚙️ Training Details
|
89 |
+
|
90 |
+
### 🏋️ Training Data
|
91 |
+
* Trained on a curated dataset emphasizing emotional intelligence, human psychology, and nuanced conversation.
|
92 |
+
* Includes dialogues from mental health scenarios, coaching sessions, and empathetic responses.
|
93 |
+
|
94 |
+
### 📌 Capabilities
|
95 |
+
* **Understands and analyzes emotions** with high accuracy.
|
96 |
+
* **Provides tailored emotional insights** instead of generic responses.
|
97 |
+
* **Capable of deep reasoning** for emotional problem-solving.
|
98 |
+
|
99 |
+
## ⚠️ Limitations
|
100 |
+
|
101 |
+
* **Still evolving** – may not always capture deep emotions perfectly.
|
102 |
+
* **Not a replacement for professional therapy** – designed to support, not diagnose.
|
103 |
+
* **Best used with human moderation** in sensitive situations.
|
104 |
+
|
105 |
+
## 📚 Citation
|
106 |
+
|
107 |
+
```bibtex
|
108 |
+
@misc{haiser2025,
|
109 |
+
author = {HelpingAI Team},
|
110 |
+
title = {HAI-SER: Structured Emotional Reasoning for Empathetic AI},
|
111 |
+
year = {2025},
|
112 |
+
publisher = {HelpingAI},
|
113 |
+
journal = {HuggingFace},
|
114 |
+
howpublished = {\url{https://huggingface.co/HelpingAI/HAI-SER}}
|
115 |
+
}
|
116 |
+
```
|
117 |
+
|
118 |
+
---
|
119 |
+
**Created with ❤️ by HelpingAI**
|
120 |
+
|
121 |
+
[🌐 Website](https://helpingai.co) • [📜 License](https://helpingai.co/license) • [🤗 HuggingFace](https://huggingface.co/HelpingAI) • [💬 Discord](https://discord.gg/YweJwNqrnH)
|