README.md

---
license: other
license_name: hsul
license_link: https://huggingface.co/OEvortex/vortex-3b/raw/main/LICENSE.md
language:
- en
pipeline_tag: text-generation
tags:
- 3B
---
# HelpingAI-3B
![logo](HelpingAI.png)
## Introduction

HelpingAI-3B is a state-of-the-art AI model designed to assist with day-to-day tasks. It's trained on a diverse range of datasets, making it versatile and adaptable to various applications.

## Model Overview

HelpingAI-3B is the latest model in the HelpingAI series. It's built on advanced machine learning algorithms and trained on a wide variety of data sources. This ensures that the model is capable of understanding and generating responses in a wide range of contexts.
## Performance Comparison

The performance of HelpingAI-3B is compared with other relevant models on various metrics in the table below:

| Model | Average | ARC | HellaSwag | MMLU | TruthfulQA | Winogrande | GSM8K |
|-|-|-|-|-|-|-|-|
| rocket-3B | 55.77 | 50.6 | 76.69 | 47.1 | 55.82 | 67.96 | 36.47 |
| **HelpingAI-3B** | **55.59** | **50.6** | **76.64** | **46.82** | **55.62** | **67.8** | **36.09** |
| stableLM-zephyr-3b | 53.43 | 46.08 | 74.16 | 46.17 | 46.49 | 65.51 | 42.15 |
| mmd-3b | 53.22 | 44.8 | 70.41 | 50.9 | 43.2 | 66.22 | 43.82 |
| MiniGPT-3B-Bacchus | 52.55 | 43.52 | 70.45 | 50.49 | 43.52 | 66.85 | 40.49 |
| MiniGPT-3B-Hercules-v2.0 | 52.52 | 43.26 | 71.11 | 51.82 | 40.37 | 66.46 | 42.08 |
| MiniGPT-3B-OpenHermes-2.5-v2 | 51.91 | 47.44 | 72 | 53.06 | 42.28 | 65.43 | 31.24 |
| MiniChat-2-3B | 51.49 | 44.88 | 67.69 | 47.59 | 49.64 | 66.46 | 32.68 |
| smol-3b | 50.27 | 46.33 | 68.23 | 46.33 | 50.73 | 65.35 | 24.64 |
| MiniChat-1.5-3B | 50.23 | 46.5 | 68.28 | 46.67 | 50.71 | 65.04 | 24.18 |
| 3BigReasonCinder | 48.16 | 41.72 | 65.16 | 44.79 | 44.76 | 64.96 | 27.6 |
| MintMerlin-3B | 47.63 | 44.37 | 66.56 | 43.21 | 47.07 | 64.4 | 20.17 |

## Simple Usage Code
```python
import torch
from transformers import AutoModelForCausalLM, AutoTokenizer, TextStreamer

# Let's bring in the big guns! Our super cool HelpingAI-3B model
model = AutoModelForCausalLM.from_pretrained("OEvortex/HelpingAI-3B", trust_remote_code=True, torch_dtype=torch.bfloat16).to("cuda")

# We also need the special HelpingAI translator to understand our chats
tokenizer = AutoTokenizer.from_pretrained("OEvortex/HelpingAI-3B", trust_remote_code=True, torch_dtype=torch.bfloat16)

# This TextStreamer thingy is our secret weapon for super smooth conversation flow
streamer = TextStreamer(tokenizer)

# Now, here comes the magic! ✨ This is the basic template for our chat
prompt = """
<|im_start|>system: {system}
<|im_end|>
<|im_start|>user: {insaan}
<|im_end|>
<|im_start|>assistant:
"""

# Okay, enough chit-chat, let's get down to business!  Here's what our system will say to the user
system = "You are an adaptive and versatile AI assistant, ready to help with various topics and situations while maintaining a conversational, engaging, and friendly tone. You aim to provide accurate, comprehensive information and advice. Be open to feedback and adjust your responses based on user input. Always show empathy and understanding in your conversations."


# And the insaan is curious (like you!) insaan means user in hindi
insaan = "Hey HelpingAI, how's it going?"

# Now we combine system and user messages into the template, like adding sprinkles to our conversation cupcake
prompt = prompt.format(system=system, insaan=insaan)

# Time to chat! We'll use the tokenizer to translate our text into a language the model understands
inputs = tokenizer(prompt, return_tensors="pt", return_attention_mask=False).to("cuda")

# Here comes the fun part!  Let's unleash the power of HelpingAI-3B to generate some awesome text
generated_text = model.generate(**inputs, max_length=3084, top_p=0.95, do_sample=True, temperature=0.7, use_cache=True, streamer=streamer)
```