Instructions to use typeof/neural-chat-7b-v3-1-sharded with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use typeof/neural-chat-7b-v3-1-sharded with Transformers:

# Use a pipeline as a high-level helper
from transformers import pipeline

pipe = pipeline("text-generation", model="typeof/neural-chat-7b-v3-1-sharded")

# Load model directly
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("typeof/neural-chat-7b-v3-1-sharded")
model = AutoModelForCausalLM.from_pretrained("typeof/neural-chat-7b-v3-1-sharded")

Notebooks
Google Colab
Kaggle
Local Apps Settings

vLLM

How to use typeof/neural-chat-7b-v3-1-sharded with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "typeof/neural-chat-7b-v3-1-sharded"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "typeof/neural-chat-7b-v3-1-sharded",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Use Docker

docker model run hf.co/typeof/neural-chat-7b-v3-1-sharded

SGLang

How to use typeof/neural-chat-7b-v3-1-sharded with SGLang:

Install from pip and serve model

# Install SGLang from pip:
pip install sglang
# Start the SGLang server:
python3 -m sglang.launch_server \
    --model-path "typeof/neural-chat-7b-v3-1-sharded" \
    --host 0.0.0.0 \
    --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "typeof/neural-chat-7b-v3-1-sharded",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Use Docker images

docker run --gpus all \
    --shm-size 32g \
    -p 30000:30000 \
    -v ~/.cache/huggingface:/root/.cache/huggingface \
    --env "HF_TOKEN=<secret>" \
    --ipc=host \
    lmsysorg/sglang:latest \
    python3 -m sglang.launch_server \
        --model-path "typeof/neural-chat-7b-v3-1-sharded" \
        --host 0.0.0.0 \
        --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "typeof/neural-chat-7b-v3-1-sharded",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Docker Model Runner
How to use typeof/neural-chat-7b-v3-1-sharded with Docker Model Runner:
```
docker model run hf.co/typeof/neural-chat-7b-v3-1-sharded
```

Fine-tuning on Habana Gaudi2

This model is a fine-tuned model based on mistralai/Mistral-7B-v0.1 on the open source dataset Open-Orca/SlimOrca. Then we align it with DPO algorithm. For more details, you can refer our blog: The Practice of Supervised Fine-tuning and Direct Preference Optimization on Habana Gaudi2.

Model date

Neural-chat-7b-v3-1 was trained between September and October, 2023.

Evaluation

We submit our model to open_llm_leaderboard, and the model performance has been improved significantly as we see from the average metric of 7 tasks from the leaderboard.

Model	Average ⬆️	ARC (25-s) ⬆️	HellaSwag (10-s) ⬆️	MMLU (5-s) ⬆️	TruthfulQA (MC) (0-s) ⬆️	Winogrande (5-s)	GSM8K (5-s)	DROP (3-s)
mistralai/Mistral-7B-v0.1	50.32	59.58	83.31	64.16	42.15	78.37	18.12	6.14
Intel/neural-chat-7b-v3	57.31	67.15	83.29	62.26	58.77	78.06	1.21	50.43
Intel/neural-chat-7b-v3-1	59.06	66.21	83.64	62.37	59.65	78.14	19.56	43.84

Training procedure

Training hyperparameters

The following hyperparameters were used during training:

learning_rate: 1e-04
train_batch_size: 1
eval_batch_size: 2
seed: 42
distributed_type: multi-HPU
num_devices: 8
gradient_accumulation_steps: 8
total_train_batch_size: 64
total_eval_batch_size: 8
optimizer: Adam with betas=(0.9,0.999) and epsilon=1e-08
lr_scheduler_type: cosine
lr_scheduler_warmup_ratio: 0.03
num_epochs: 2.0

Training sample code

Here is the sample code to reproduce the model: Sample Code.

Prompt Template

### System:
{system}
### User:
{usr}
### Assistant:

Inference with transformers

import transformers


model_name = 'Intel/neural-chat-7b-v3-1'
model = transformers.AutoModelForCausalLM.from_pretrained(model_name)
tokenizer = transformers.AutoTokenizer.from_pretrained(model_name)


def generate_response(system_input, user_input):
    
    # Format the input using the provided template
    prompt = f"### System:\n{system_input}\n### User:\n{user_input}\n### Assistant:\n"

    # Tokenize and encode the prompt
    inputs = tokenizer.encode(prompt, return_tensors="pt")

    # Generate a response
    outputs = model.generate(inputs, max_length=1000, num_return_sequences=1)
    response = tokenizer.decode(outputs[0], skip_special_tokens=True)

    # Extract only the assistant's response
    return response.split("### Assistant:\n")[-1]


# Example usage
system_input = "You are a chatbot developed by Intel. Please answer all questions to the best of your ability."
user_input = "How does the neural-chat-7b-v3-1 model work?"
response = generate_response(system_input, user_input)
print(response)

Ethical Considerations and Limitations

neural-chat-7b-v3-1 can produce factually incorrect output, and should not be relied on to produce factually accurate information. neural-chat-7b-v3-1 was trained on Open-Orca/SlimOrca based on mistralai/Mistral-7B-v0.1. Because of the limitations of the pretrained model and the finetuning datasets, it is possible that this model could generate lewd, biased or otherwise offensive outputs.

Therefore, before deploying any applications of neural-chat-7b-v3-1, developers should perform safety testing.

Disclaimer

The license on this model does not constitute legal advice. We are not responsible for the actions of third parties who use this model. Please cosult an attorney before using this model for commercial purposes.

Organizations developing the model

The NeuralChat team with members from Intel/DCAI/AISE/AIPT. Core team members: Kaokao Lv, Liang Lv, Chang Wang, Wenxin Zhang, Xuhui Ren, and Haihao Shen.

Useful links

Intel Neural Compressor link
Intel Extension for Transformers link

Open LLM Leaderboard Evaluation Results

Detailed results can be found here

Metric	Value
Avg.	59.06
ARC (25-shot)	66.21
HellaSwag (10-shot)	83.64
MMLU (5-shot)	62.37
TruthfulQA (0-shot)	59.65
Winogrande (5-shot)	78.14
GSM8K (5-shot)	19.56
DROP (3-shot)	43.84

Downloads last month: 2

Safetensors

Model size

7B params

Tensor type

F16

Model tree for typeof/neural-chat-7b-v3-1-sharded

Finetunes

1 model