Abhaykoul commited on
Commit
6664e70
1 Parent(s): 7b3d63f

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +73 -167
README.md CHANGED
@@ -1,199 +1,105 @@
1
  ---
2
- library_name: transformers
3
- tags: []
 
 
 
 
 
 
 
4
  ---
5
 
6
- # Model Card for Model ID
7
 
8
- <!-- Provide a quick summary of what the model is/does. -->
9
 
 
10
 
 
11
 
12
- ## Model Details
13
 
14
- ### Model Description
15
 
16
- <!-- Provide a longer summary of what this model is. -->
17
 
18
- This is the model card of a 🤗 transformers model that has been pushed on the Hub. This model card has been automatically generated.
 
 
 
 
19
 
20
- - **Developed by:** [More Information Needed]
21
- - **Funded by [optional]:** [More Information Needed]
22
- - **Shared by [optional]:** [More Information Needed]
23
- - **Model type:** [More Information Needed]
24
- - **Language(s) (NLP):** [More Information Needed]
25
- - **License:** [More Information Needed]
26
- - **Finetuned from model [optional]:** [More Information Needed]
27
 
28
- ### Model Sources [optional]
29
 
30
- <!-- Provide the basic links for the model. -->
31
 
32
- - **Repository:** [More Information Needed]
33
- - **Paper [optional]:** [More Information Needed]
34
- - **Demo [optional]:** [More Information Needed]
35
 
36
- ## Uses
37
 
38
- <!-- Address questions around how the model is intended to be used, including the foreseeable users of the model and those affected by the model. -->
39
 
40
- ### Direct Use
41
 
42
- <!-- This section is for the model use without fine-tuning or plugging into a larger ecosystem/app. -->
43
 
44
- [More Information Needed]
45
 
46
- ### Downstream Use [optional]
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
47
 
48
- <!-- This section is for the model use when fine-tuned for a task, or when plugged into a larger ecosystem/app -->
 
 
 
49
 
50
- [More Information Needed]
 
51
 
52
- ### Out-of-Scope Use
 
53
 
54
- <!-- This section addresses misuse, malicious use, and uses that the model will not work well for. -->
 
55
 
56
- [More Information Needed]
 
 
 
 
 
 
 
57
 
58
- ## Bias, Risks, and Limitations
 
 
59
 
60
- <!-- This section is meant to convey both technical and sociotechnical limitations. -->
61
 
62
- [More Information Needed]
 
63
 
64
- ### Recommendations
 
65
 
66
- <!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
 
67
 
68
- Users (both direct and downstream) should be made aware of the risks, biases and limitations of the model. More information needed for further recommendations.
 
69
 
70
- ## How to Get Started with the Model
71
-
72
- Use the code below to get started with the model.
73
-
74
- [More Information Needed]
75
-
76
- ## Training Details
77
-
78
- ### Training Data
79
-
80
- <!-- 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. -->
81
-
82
- [More Information Needed]
83
-
84
- ### Training Procedure
85
-
86
- <!-- This relates heavily to the Technical Specifications. Content here should link to that section when it is relevant to the training procedure. -->
87
-
88
- #### Preprocessing [optional]
89
-
90
- [More Information Needed]
91
-
92
-
93
- #### Training Hyperparameters
94
-
95
- - **Training regime:** [More Information Needed] <!--fp32, fp16 mixed precision, bf16 mixed precision, bf16 non-mixed precision, fp16 non-mixed precision, fp8 mixed precision -->
96
-
97
- #### Speeds, Sizes, Times [optional]
98
-
99
- <!-- This section provides information about throughput, start/end time, checkpoint size if relevant, etc. -->
100
-
101
- [More Information Needed]
102
-
103
- ## Evaluation
104
-
105
- <!-- This section describes the evaluation protocols and provides the results. -->
106
-
107
- ### Testing Data, Factors & Metrics
108
-
109
- #### Testing Data
110
-
111
- <!-- This should link to a Dataset Card if possible. -->
112
-
113
- [More Information Needed]
114
-
115
- #### Factors
116
-
117
- <!-- These are the things the evaluation is disaggregating by, e.g., subpopulations or domains. -->
118
-
119
- [More Information Needed]
120
-
121
- #### Metrics
122
-
123
- <!-- These are the evaluation metrics being used, ideally with a description of why. -->
124
-
125
- [More Information Needed]
126
-
127
- ### Results
128
-
129
- [More Information Needed]
130
-
131
- #### Summary
132
-
133
-
134
-
135
- ## Model Examination [optional]
136
-
137
- <!-- Relevant interpretability work for the model goes here -->
138
-
139
- [More Information Needed]
140
-
141
- ## Environmental Impact
142
-
143
- <!-- Total emissions (in grams of CO2eq) and additional considerations, such as electricity usage, go here. Edit the suggested text below accordingly -->
144
-
145
- 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).
146
-
147
- - **Hardware Type:** [More Information Needed]
148
- - **Hours used:** [More Information Needed]
149
- - **Cloud Provider:** [More Information Needed]
150
- - **Compute Region:** [More Information Needed]
151
- - **Carbon Emitted:** [More Information Needed]
152
-
153
- ## Technical Specifications [optional]
154
-
155
- ### Model Architecture and Objective
156
-
157
- [More Information Needed]
158
-
159
- ### Compute Infrastructure
160
-
161
- [More Information Needed]
162
-
163
- #### Hardware
164
-
165
- [More Information Needed]
166
-
167
- #### Software
168
-
169
- [More Information Needed]
170
-
171
- ## Citation [optional]
172
-
173
- <!-- If there is a paper or blog post introducing the model, the APA and Bibtex information for that should go in this section. -->
174
-
175
- **BibTeX:**
176
-
177
- [More Information Needed]
178
-
179
- **APA:**
180
-
181
- [More Information Needed]
182
-
183
- ## Glossary [optional]
184
-
185
- <!-- If relevant, include terms and calculations in this section that can help readers understand the model or model card. -->
186
-
187
- [More Information Needed]
188
-
189
- ## More Information [optional]
190
-
191
- [More Information Needed]
192
-
193
- ## Model Card Authors [optional]
194
-
195
- [More Information Needed]
196
-
197
- ## Model Card Contact
198
-
199
- [More Information Needed]
 
1
  ---
2
+ license: other
3
+ license_name: hsul
4
+ license_link: https://huggingface.co/OEvortex/vortex-3b/raw/main/LICENSE.md
5
+ language:
6
+ - en
7
+ pipeline_tag: text-generation
8
+ tags:
9
+ - 3B
10
+ - Emotionally Intelligent
11
  ---
12
 
 
13
 
14
+ # HelpingAI-3B-v2.2: Emotionally Intelligent Conversational AI
15
 
16
+ ![logo](https://huggingface.co/OEvortex/HelpingAI-3B/resolve/main/HelpingAI.png)
17
 
18
+ ## Introduction
19
 
20
+ HelpingAI-3B-v2.2 is a state-of-the-art large language model specializing in emotionally intelligent conversation. With advanced emotional understanding capabilities, it can engage in empathetic dialogue tailored to the user's emotional state and context.
21
 
22
+ ## Emotional Intelligence Capabilities
23
 
24
+ HelpingAI-3B-v2.2 exhibits several key traits that enable emotionally resonant responses:
25
 
26
+ - Emotion recognition and validation
27
+ - Empathetic perspective-taking
28
+ - Generating emotionally supportive language
29
+ - Contextual emotional attunement
30
+ - Using appropriate tone, word choice and emotional expression
31
 
32
+ Whether comforting someone grieving, celebrating positive news, or addressing complex feelings, HelpingAI-3B-v2.2 can adapt its communication style with emotional nuance.
 
 
 
 
 
 
33
 
34
+ ## Examples of Emotionally Intelligent Responses
35
 
36
+ "Oh no! 😔 Dealing with printer issues can be frustrating. Let's try to help you get it up and running. First, make sure the printer is properly connected to the power source and your computer. Check if there are any error messages or blinking lights on the printer. It's also a good idea to restart both the printer and your computer. If the issue persists, you may need to reinstall the printer drivers or check for any hardware issues. Let me know if you need more help! "
37
 
38
+ "It's really sad to hear about your friend's loss. 😔 Losing a parent can be incredibly painful and heart-wrenching. It's important to show them empathy and support during this difficult time. You Offer to be there for them and listen to them when they're ready to talk. You Send them thoughtful and comforting messages to let them know that you are thinking of them and that they are not alone. Offer to help them with any practical tasks or duties they might have, like running errands or taking care of animals. Remember, everyone experiences grief differently, so it's essential to be patient and understanding. Offer your friend a hug if they're comfortable with it, and remind them that you are there for them. 🌼"
 
 
39
 
40
+ The model tailors its language, tone and emotional content to be contextually appropriate, combining emotional intelligence with factual knowledge and practical suggestions.
41
 
 
42
 
 
43
 
44
+ ## Performance Comparison
45
 
46
+ The performance of HelpingAI-3B-v2.2 is compared with other relevant models on various metrics in the table below:
47
 
48
+ | Model | Average | ARC | HellaSwag | MMLU | TruthfulQA | Winogrande | GSM8K |
49
+ |-|-|-|-|-|-|-|-|
50
+ | **HelpingAI-3B-v2.2** | **57.555** | **53.14** | **82.61** | **47.42** | **57.92** | **68.15** | **36.09** |
51
+ | **HelpingAI-3B-v2.1** | **57.44** | **53.14** | **82.61** | **47.42** | **57.92** | **68.15** | **35.39** |
52
+ | rocket-3B | 55.77 | 50.6 | 76.69 | 47.1 | 55.82 | 67.96 | 36.47 |
53
+ | **HelpingAI-3B** | **55.59** | **50.6** | **76.64** | **46.82** | **55.62** | **67.8** | **36.09** |
54
+ | stableLM-zephyr-3b | 53.43 | 46.08 | 74.16 | 46.17 | 46.49 | 65.51 | 42.15 |
55
+ | mmd-3b | 53.22 | 44.8 | 70.41 | 50.9 | 43.2 | 66.22 | 43.82 |
56
+ | MiniGPT-3B-Bacchus | 52.55 | 43.52 | 70.45 | 50.49 | 43.52 | 66.85 | 40.49 |
57
+ | MiniGPT-3B-Hercules-v2.0 | 52.52 | 43.26 | 71.11 | 51.82 | 40.37 | 66.46 | 42.08 |
58
+ | MiniGPT-3B-OpenHermes-2.5-v2 | 51.91 | 47.44 | 72 | 53.06 | 42.28 | 65.43 | 31.24 |
59
+ | MiniChat-2-3B | 51.49 | 44.88 | 67.69 | 47.59 | 49.64 | 66.46 | 32.68 |
60
+ | smol-3b | 50.27 | 46.33 | 68.23 | 46.33 | 50.73 | 65.35 | 24.64 |
61
+ | MiniChat-1.5-3B | 50.23 | 46.5 | 68.28 | 46.67 | 50.71 | 65.04 | 24.18 |
62
+ | 3BigReasonCinder | 48.16 | 41.72 | 65.16 | 44.79 | 44.76 | 64.96 | 27.6 |
63
+ | MintMerlin-3B | 47.63 | 44.37 | 66.56 | 43.21 | 47.07 | 64.4 | 20.17 |
64
 
65
+ ## Simple Usage Code
66
+ ```python
67
+ import torch
68
+ from transformers import AutoModelForCausalLM, AutoTokenizer, TextStreamer
69
 
70
+ # Let's bring in the big guns! Our super cool HelpingAI-3B model
71
+ model = AutoModelForCausalLM.from_pretrained("OEvortex/HelpingAI-3B-v2.2", trust_remote_code=True, torch_dtype=torch.float16).to("cuda")
72
 
73
+ # We also need the special HelpingAI translator to understand our chats
74
+ tokenizer = AutoTokenizer.from_pretrained("OEvortex/HelpingAI-3B-v2.2", trust_remote_code=True, torch_dtype=torch.float16)
75
 
76
+ # This TextStreamer thingy is our secret weapon for super smooth conversation flow
77
+ streamer = TextStreamer(tokenizer)
78
 
79
+ # Now, here comes the magic! ✨ This is the basic template for our chat
80
+ prompt = """
81
+ <|im_start|>system: {system}
82
+ <|im_end|>
83
+ <|im_start|>user: {insaan}
84
+ <|im_end|>
85
+ <|im_start|>assistant:
86
+ """
87
 
88
+ # Okay, enough chit-chat, let's get down to business! Here's what our system will be our system prompt
89
+ # We recommend to Use HelpingAI style in system prompt as this model is just trained on 3.7K rows of fealings dataset and we are working on even better model
90
+ system = "You are HelpingAI a emotional AI always answer my question in HelpingAI style"
91
 
 
92
 
93
+ # And the insaan is curious (like you!) insaan means human in hindi
94
+ insaan = "My best friend recently lost their parent to cancer after a long battle. They are understandably devastated and struggling with grief. What would be a caring and supportive way to respond to help them through this difficult time?"
95
 
96
+ # Now we combine system and user messages into the template, like adding sprinkles to our conversation cupcake
97
+ prompt = prompt.format(system=system, insaan=insaan)
98
 
99
+ # Time to chat! We'll use the tokenizer to translate our text into a language the model understands
100
+ inputs = tokenizer(prompt, return_tensors="pt", return_attention_mask=False).to("cuda")
101
 
102
+ # Here comes the fun part! Let's unleash the power of HelpingAI-3B to generate some awesome text
103
+ generated_text = model.generate(**inputs, max_length=3084, top_p=0.95, do_sample=True, temperature=0.6, use_cache=True, streamer=streamer)
104
 
105
+ ```