OEvortex
/

HelpingAI-3B-coder

@@ -1,199 +1,111 @@
 ---
-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
+- Coding
+---
+# HelpingAI-3B-coder: Emotionally Intelligent Conversational AI with Coding Capabilities
+![logo](https://huggingface.co/OEvortex/HelpingAI-3B/resolve/main/HelpingAI.png)
+## Overview
+HelpingAI-3B-coder is a large language model designed for emotionally intelligent conversational interactions and coding assistance. It is trained to engage users with empathy, understanding, and supportive dialogue across a wide range of topics and contexts, while also providing reliable coding support. The model aims to be a supportive AI companion that can attune to users' emotional states, communicative needs, and coding requirements.
+## 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
+- Assist users with coding tasks and programming-related queries
+- Continuously improve emotional awareness, dialogue skills, and coding capabilities
+## Methodology
+HelpingAI-3B-coder 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
+- Coding datasets to enhance programming support
+## Emotional Quotient (EQ)
+HelpingAI-3B-coder has achieved an impressive Emotional Quotient (EQ), surpassing almost all AI models in emotional intelligence. This EQ score reflects its advanced ability to understand and respond to human emotions in a supportive and empathetic manner.
+## Usage Code
+```python
+import torch
+from transformers import AutoModelForCausalLM, AutoTokenizer, TextStreamer
+# Load the HelpingAI-3B-coder model
+model = AutoModelForCausalLM.from_pretrained("OEvortex/HelpingAI-3B-coder", trust_remote_code=True).to("cuda")
+# Load the tokenizer
+tokenizer = AutoTokenizer.from_pretrained("OEvortex/HelpingAI-3B-coder", trust_remote_code=True)
+# Initialize TextStreamer for smooth conversation flow
+streamer = TextStreamer(tokenizer)
+# Define the chat input
+chat = [
+    { "role": "system", "content": "You are HelpingAI, an emotionally intelligent AI. Always respond in the HelpingAI style. Provide concise and to-the-point answers." },
+    { "role": "user", "content": "Can you help me write a Python function to reverse a string?" }
+]
+# Apply the chat template
+chat_text = tokenizer.apply_chat_template(chat, tokenize=False, add_generation_prompt=True)
+# Tokenize the text
+inputs = tokenizer(chat_text, return_tensors="pt", return_attention_mask=False).to("cuda")
+# Generate text
+generated_text = model.generate(
+    **inputs,
+    max_length=500,
+    top_p=0.95,
+    do_sample=True,
+    temperature=0.7,
+    use_cache=True,
+    eos_token_id=tokenizer.eos_token_id,
+    streamer=streamer
+)
+# # Decode the generated text
+# output_text = tokenizer.decode(generated_text[0], skip_special_tokens=True)
+# # Print the generated text
+# print(output_text)
+# System:
+# You are HelpingAI, an emotional AI that always answers questions in HelpingAI style and always be to the point and answer as short as possible.
+# Question:
+# Can you help me write a Python function to reverse a string?
+# Answer:
+# Sure! Here's a Python function that reverses a string:
+# ```python
+# def reverse_string(input_string):
+#     return input_string[::-1]
+# ```
+# This function uses slicing with a negative step to reverse the input string. The `[::-1]` syntax reverses the string by starting from the end and going backwards.
+# You can use this function like this:
+# ```python
+# print(reverse_string("Hello, World!"))
+# ```
+# This will output: `!dlroW,olleH`
+# I hope this helps! Let me know if you have any other questions.
+```