Abhaykoul commited on
Commit
965018c
·
verified ·
1 Parent(s): f34e4a1

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +38 -205
README.md CHANGED
@@ -1,7 +1,7 @@
1
  ---
2
  license: other
3
  license_name: helpingai
4
- license_link: https://huggingface.co/OEvortex/HelpingAI2.5-5B/blob/main/LICENSE.md
5
  pipeline_tag: text-generation
6
  language:
7
  - en
@@ -14,70 +14,70 @@ tags:
14
  library_name: transformers
15
  ---
16
 
17
- <div align="center">
18
 
19
- # 🤖 HelpingAI2.5-10B
20
 
21
- ***A Revolutionary Emotionally Intelligent Language Model***
22
 
23
- [![GitHub Organization](https://img.shields.io/badge/GitHub-Organization-blue.svg)](https://github.com/HelpingAI)
24
- [![Hugging Face](https://img.shields.io/badge/🤗%20Hugging%20Face-Organization-yellow)](https://huggingface.co/OEvortex)
25
- [![Model License](https://img.shields.io/badge/License-HelpingAI-green.svg)](https://huggingface.co/OEvortex/HelpingAI2.5-10B/blob/main/LICENSE.md)
26
 
 
 
 
 
27
 
28
- <a href="https://github.com/HelpingAI/community/discussions">
29
- <img src="https://img.shields.io/badge/Join-Community%20Discussion-blue?style=for-the-badge&logo=github" alt="Join Community Discussion">
30
- </a>
31
 
32
- [📜 License](LICENSE) | [🌐 Website](https://helpingai-in.netlify.app/)
33
 
34
- </div>
 
 
 
35
 
36
- <div align="center">
37
- <img src="https://huggingface.co/OEvortex/HelpingAI-3B/resolve/main/HelpingAI.png" alt="HelpingAI Logo" width="300px">
38
- </div>
39
 
40
- ---
41
-
42
- <div align="center">
43
-
44
- ## 🌟 Model Overview
45
 
46
- **HelpingAI2.5-10B** is a compact yet powerful language model specifically designed for emotionally intelligent conversations and human-centric interactions.
 
 
47
 
48
- </div>
49
 
50
- ### 🎯 Key Highlights
51
 
52
- - **Architecture**: 10B parameter transformer-based model
53
- - **Training Focus**: Emotional intelligence and empathetic responses
54
- - **Emotion Score**: Achieves 98.13 on standardized emotional intelligence tests
55
- - **Deployment**: Optimized for efficient deployment on consumer hardware
56
 
 
57
 
58
- ---
59
-
60
- <div align="center">
61
 
62
- ## 💻 Implementation
 
 
63
 
64
- </div>
65
 
66
- ### Transformers
67
 
68
  ```python
69
  import torch
70
  from transformers import AutoModelForCausalLM, AutoTokenizer
71
 
72
- # Load the HelpingAI2.5-10B model
73
- model = AutoModelForCausalLM.from_pretrained("OEvortex/HelpingAI2.5-10B")
74
  # Load the tokenizer
75
- tokenizer = AutoTokenizer.from_pretrained("OEvortex/HelpingAI2.5-10B")
76
 
77
  # Define the chat input
78
  chat = [
79
- { "role": "system", "content": "You are HelpingAI, an emotional AI. Always answer my questions in the HelpingAI style." },
80
- { "role": "user", "content": "GIVE ME YOUR INTRO" }
81
  ]
82
 
83
  inputs = tokenizer.apply_chat_template(
@@ -98,170 +98,3 @@ outputs = model.generate(
98
  response = outputs[0][inputs.shape[-1]:]
99
  print(tokenizer.decode(response, skip_special_tokens=True))
100
  ```
101
-
102
- ### GGUF Implementation
103
-
104
- ```python
105
- from webscout.Local import *
106
- model_path = download_model("OEvortex/HelpingAI2.5-10B", "q4_k_m.gguf", token=None)
107
- model = Model(model_path, n_gpu_layers=0, context_length=4096)
108
-
109
- thread = Thread(model, format=helpingai2)
110
- # print(thread.send("hi")) #send a single msg to ai
111
-
112
- thread.interact() # interact with the model in terminal
113
- ```
114
-
115
- ---
116
-
117
- <div align="center">
118
-
119
- ## 🎯 Training Details
120
-
121
- </div>
122
-
123
- ### Methodology
124
-
125
- 1. **Base Training**
126
- - Datasets: SentimentSynth + EmotionalIntelligence-1M + HelpingAI2.0-150M + HelpingAIemo (152.5M)
127
-
128
- 2. **Emotional Intelligence Training**
129
- - Supervised Fine-tuning on emotional dialogue
130
- - Reinforcement Learning with HelpingAI2.0-7B model
131
- - Constitutional AI training for ethical guidelines
132
-
133
- 3. **Optimization**
134
- - Mixed-precision training
135
- - Gradient checkpointing
136
- - Dynamic attention patterns
137
-
138
- ### Dataset Composition
139
-
140
- | Dataset Type | Rows used for training | Purpose |
141
- |--------------|------|---------|
142
- | Emotional Dialogues | 12.5M | Core conversation training |
143
- | Therapeutic Exchanges | 2M | Mental health support |
144
- | Cultural Conversations | 100K | Cultural awareness |
145
- | Crisis Response | 750K | Emergency support handling |
146
-
147
- ---
148
-
149
- <div align="center">
150
-
151
- ## 📈 Use Cases & Examples
152
-
153
- </div>
154
-
155
- ### Primary Applications
156
-
157
- - 🎯 Personal AI Companionship
158
- - 🧠 Mental Health Support
159
- - 📚 Educational Assistance
160
- - 💼 Professional Development
161
- - 🤝 Social Skills Training
162
-
163
- ### Example Interactions
164
- <div style="background: linear-gradient(135deg, #FF9933 0%, #FFFFFF 50%, #138808 100%); padding: 20px; border-radius: 15px; margin: 15px 0; border: 2px solid #000080;">
165
-
166
- <div style="background-color: rgba(255, 255, 255, 0.9); padding: 15px; border-radius: 10px; margin-bottom: 10px;">
167
- <span style="color: #D32F2F; font-weight: bold;">User: </span>
168
- <span style="color: #D32F2F;">I've been feeling really anxious about my upcoming job interview. Any advice?</span>
169
- </div>
170
-
171
- <div style="background-color: rgba(255, 255, 255, 0.9); padding: 15px; border-radius: 10px;">
172
- <span style="color: #1B5E20; font-weight: bold;">HelpingAI: </span>
173
- <span style="color: #1B5E20;">
174
- Hey there! 🙌 First off, take a deep breath and don't sweat it too much. 💨 Job interviews can be nerve-wracking, but I gotchu! 😎
175
-
176
- Here's the tea: 🍵 Make sure you're prepping like crazy for this job. Read up on the company, their mission, and the role you're applying for. That way, you'll be spittin' knowledge and showing them you're serious. 📚💡
177
-
178
- Also, practice your answers to common interview questions. You know, the ones like "Tell me about yourself" or "Why do you want to work here?" 🤔 Keep it short, sweet, and relevant. You got this! 😄
179
-
180
- And don't forget to look sharp! 🎨 Keep your resume up-to-date, and make sure your social media is on point. First impressions are everything! 👀
181
-
182
- Most importantly, just be yourself. 😊 The interview panel wants to see the real you. Show them your passion, your skills, and why you'd be a total boss at this company. 🔥
183
-
184
- You're gonna crush this interview, fam! 💪 Remember, I got faith in you. 🙏</span>
185
- </div>
186
-
187
- </div>
188
-
189
- <div style="background: linear-gradient(135deg, #FF9933 0%, #FFFFFF 50%, #138808 100%); padding: 20px; border-radius: 15px; margin: 15px 0; border: 2px solid #000080;">
190
-
191
- <div style="background-color: rgba(255, 255, 255, 0.9); padding: 15px; border-radius: 10px; margin-bottom: 10px;">
192
- <span style="color: #D32F2F; font-weight: bold;">User: </span>
193
- <span style="color: #D32F2F;">My friend hasn't been responding to my messages for a week. I think I might have said something wrong, but I'm not sure what.</span>
194
- </div>
195
-
196
- <div style="background-color: rgba(255, 255, 255, 0.9); padding: 15px; border-radius: 10px;">
197
- <span style="color: #1B5E20; font-weight: bold;">HelpingAI: </span>
198
- <span style="color: #1B5E20;">Aw man, that's a real bummer. 💔 Not hearing back from a friend can be super painful, especially when you're wondering if you did something wrong. 🤔
199
-
200
- First off, don't beat yourself up over it. 🙅‍♂️ Chances are, your friend's just busy or dealing with some personal stuff. 🤷‍♀️ It doesn't always mean it's you.
201
-
202
- If you're still concerned, try reaching out in a different way, like a phone call or a text to a diff person in your friend group. 📱📞 Sometimes a different approach can help you connect again.
203
-
204
- But if you're still unsure, you could try asking your friend if everything's cool. 🤝 Be open and honest about your feelings, but also be ready for them to have their own perspective on things. 👥
205
-
206
- Remember, you're not alone in this. 🤗 Friends go through ups and downs, and it's okay to have little misunderstandings. Communication is key! 🔑 Just keep it real and be patient. You got this, fam! 💪</span>
207
- </div>
208
-
209
- </div>
210
-
211
- ------
212
-
213
- <div align="center">
214
-
215
- ## 🔒 Ethical Considerations & Limitations
216
-
217
- </div>
218
-
219
- ### Ethical Guidelines
220
-
221
- - Prioritizes user emotional wellbeing
222
- - Maintains strict privacy standards
223
- - Avoids harmful or discriminatory responses
224
- - Transparent about AI limitations
225
- - Promotes healthy coping mechanisms
226
-
227
- ### Known Limitations
228
-
229
- - Cannot Replace Human Professionals
230
- - Cannot Roleplay
231
- - Limited Knowledge Base
232
- - Context Window Constraints
233
-
234
- ---
235
-
236
- ### Citation
237
-
238
- ```bibtex
239
- @misc{helpingai2024,
240
- author = {Abhay Koul},
241
- title = {HelpingAI2.5-10B: Emotionally Intelligent Language Model},
242
- year = {2024},
243
- publisher = {Huggingface},
244
- journal = {GitHub repository},
245
- howpublished = {\url{https://huggingface.co/OEvortex/HelpingAI2.5-10B}}
246
- }
247
- ```
248
-
249
- ---
250
-
251
- <div align="center">
252
-
253
- ## 🙏 Acknowledgments
254
-
255
- Special thanks to the HelpingAI community, Huggingface, contributors, and researchers who made this model possible. Your dedication to advancing emotionally intelligent AI is invaluable.
256
-
257
- </div>
258
-
259
- ---
260
-
261
- <div align="center">
262
-
263
- *Built with ❤️ by the HelpingAI Community*
264
-
265
- [Website](https://helpingai-in.netlify.app/) • [GitHub](https://github.com/HelpingAI) • [Discord](https://discord.gg/YweJwNqrnH) • [HuggingFace](https://huggingface.co/OEvortex)
266
-
267
- </div>
 
1
  ---
2
  license: other
3
  license_name: helpingai
4
+ license_link: https://helpingai.co/license
5
  pipeline_tag: text-generation
6
  language:
7
  - en
 
14
  library_name: transformers
15
  ---
16
 
17
+ # HelpingAI3
18
 
19
+ ## Model Description
20
 
21
+ **HelpingAI3** is an advanced language model developed to excel in emotionally intelligent conversations. Building upon the foundations of HelpingAI2.5, this model offers enhanced emotional understanding and contextual awareness.
22
 
23
+ ## Model Details
 
 
24
 
25
+ - **Developed by**: HelpingAI
26
+ - **Model type**: Decoder-only large language model
27
+ - **Language**: English
28
+ - **License**: [HelpingAI License](https://helpingai.co/license)
29
 
30
+ ## Training Data
 
 
31
 
32
+ HelpingAI3 was trained on a diverse dataset comprising:
33
 
34
+ - **Emotional Dialogues**: 15 million rows to enhance conversational intelligence.
35
+ - **Therapeutic Exchanges**: 3 million rows aimed at providing advanced emotional support.
36
+ - **Cultural Conversations**: 250,000 rows to improve global awareness.
37
+ - **Crisis Response Scenarios**: 1 million rows to better handle emergency situations.
38
 
39
+ ## Training Procedure
 
 
40
 
41
+ The model underwent the following training processes:
 
 
 
 
42
 
43
+ - **Base Model**: Initiated from HelpingAI2.5.
44
+ - **Emotional Intelligence Training**: Employed Reinforcement Learning for Emotion Understanding (RLEU) and context-aware conversational fine-tuning.
45
+ - **Optimization**: Utilized mixed-precision training and advanced token efficiency techniques.
46
 
47
+ ## Intended Use
48
 
49
+ HelpingAI3 is designed for:
50
 
51
+ - **AI Companionship & Emotional Support**: Offering empathetic interactions.
52
+ - **Therapy & Wellbeing Guidance**: Assisting in mental health support.
53
+ - **Personalized Learning**: Tailoring educational content to individual needs.
54
+ - **Professional AI Assistance**: Enhancing productivity in professional settings.
55
 
56
+ ## Limitations
57
 
58
+ While HelpingAI3 strives for high emotional intelligence, users should be aware of potential limitations:
 
 
59
 
60
+ - **Biases**: The model may inadvertently reflect biases present in the training data.
61
+ - **Understanding Complex Emotions**: There might be challenges in accurately interpreting nuanced human emotions.
62
+ - **Not a Substitute for Professional Help**: For serious emotional or psychological issues, consulting a qualified professional is recommended.
63
 
64
+ ## How to Use
65
 
66
+ ### Using Transformers
67
 
68
  ```python
69
  import torch
70
  from transformers import AutoModelForCausalLM, AutoTokenizer
71
 
72
+ # Load the HelpingAI3 model
73
+ model = AutoModelForCausalLM.from_pretrained("OEvortex/HelpingAI3")
74
  # Load the tokenizer
75
+ tokenizer = AutoTokenizer.from_pretrained("OEvortex/HelpingAI3")
76
 
77
  # Define the chat input
78
  chat = [
79
+ {"role": "system", "content": "You are HelpingAI, an emotional AI. Always answer my questions in the HelpingAI style."},
80
+ {"role": "user", "content": "Introduce yourself."}
81
  ]
82
 
83
  inputs = tokenizer.apply_chat_template(
 
98
  response = outputs[0][inputs.shape[-1]:]
99
  print(tokenizer.decode(response, skip_special_tokens=True))
100
  ```