Instructions to use HelpingAI/HelpingAI2-3B with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use HelpingAI/HelpingAI2-3B with llama-cpp-python:

# !pip install llama-cpp-python

from llama_cpp import Llama

llm = Llama.from_pretrained(
	repo_id="HelpingAI/HelpingAI2-3B",
	filename="q4_k_m.gguf",
)

llm.create_chat_completion(
	messages = [
		{
			"role": "user",
			"content": "What is the capital of France?"
		}
	]
)

Notebooks
Google Colab
Kaggle
Local Apps Settings

llama.cpp

How to use HelpingAI/HelpingAI2-3B with llama.cpp:

Install (macOS, Linux)

curl -LsSf https://llama.app/install.sh | sh
# Start a local OpenAI-compatible server with a web UI:
llama serve -hf HelpingAI/HelpingAI2-3B:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf HelpingAI/HelpingAI2-3B:Q4_K_M

Install from WinGet (Windows)

winget install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama serve -hf HelpingAI/HelpingAI2-3B:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf HelpingAI/HelpingAI2-3B:Q4_K_M

Use pre-built binary

# Download pre-built binary from:
# https://github.com/ggerganov/llama.cpp/releases
# Start a local OpenAI-compatible server with a web UI:
./llama-server -hf HelpingAI/HelpingAI2-3B:Q4_K_M
# Run inference directly in the terminal:
./llama-cli -hf HelpingAI/HelpingAI2-3B:Q4_K_M

Build from source code

git clone https://github.com/ggerganov/llama.cpp.git
cd llama.cpp
cmake -B build
cmake --build build -j --target llama-server llama-cli
# Start a local OpenAI-compatible server with a web UI:
./build/bin/llama-server -hf HelpingAI/HelpingAI2-3B:Q4_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf HelpingAI/HelpingAI2-3B:Q4_K_M

Use Docker

docker model run hf.co/HelpingAI/HelpingAI2-3B:Q4_K_M

LM Studio
Jan

vLLM

How to use HelpingAI/HelpingAI2-3B with vLLM:

Install from pip and serve model

# Install vLLM from pip:
pip install vllm
# Start the vLLM server:
vllm serve "HelpingAI/HelpingAI2-3B"
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:8000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "HelpingAI/HelpingAI2-3B",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Use Docker

docker model run hf.co/HelpingAI/HelpingAI2-3B:Q4_K_M

Ollama
How to use HelpingAI/HelpingAI2-3B with Ollama:
```
ollama run hf.co/HelpingAI/HelpingAI2-3B:Q4_K_M
```

Unsloth Studio

How to use HelpingAI/HelpingAI2-3B with Unsloth Studio:

Install Unsloth Studio (macOS, Linux, WSL)

curl -fsSL https://unsloth.ai/install.sh | sh
# Run unsloth studio
unsloth studio -H 0.0.0.0 -p 8888
# Then open http://localhost:8888 in your browser
# Search for HelpingAI/HelpingAI2-3B to start chatting

Install Unsloth Studio (Windows)

irm https://unsloth.ai/install.ps1 | iex
# Run unsloth studio
unsloth studio -H 0.0.0.0 -p 8888
# Then open http://localhost:8888 in your browser
# Search for HelpingAI/HelpingAI2-3B to start chatting

Using HuggingFace Spaces for Unsloth

# No setup required
# Open https://huggingface.co/spaces/unsloth/studio in your browser
# Search for HelpingAI/HelpingAI2-3B to start chatting

How to use HelpingAI/HelpingAI2-3B with Pi:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf HelpingAI/HelpingAI2-3B:Q4_K_M

Configure the model in Pi

# Install Pi:
npm install -g @mariozechner/pi-coding-agent
# Add to ~/.pi/agent/models.json:
{
  "providers": {
    "llama-cpp": {
      "baseUrl": "http://localhost:8080/v1",
      "api": "openai-completions",
      "apiKey": "none",
      "models": [
        {
          "id": "HelpingAI/HelpingAI2-3B:Q4_K_M"
        }
      ]
    }
  }
}

Run Pi

# Start Pi in your project directory:
pi

Hermes Agent new

How to use HelpingAI/HelpingAI2-3B with Hermes Agent:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf HelpingAI/HelpingAI2-3B:Q4_K_M

Configure Hermes

# Install Hermes:
curl -fsSL https://hermes-agent.nousresearch.com/install.sh | bash
hermes setup
# Point Hermes at the local server:
hermes config set model.provider custom
hermes config set model.base_url http://127.0.0.1:8080/v1
hermes config set model.default HelpingAI/HelpingAI2-3B:Q4_K_M

Run Hermes

hermes

Atomic Chat new

OpenClaw new

How to use HelpingAI/HelpingAI2-3B with OpenClaw:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf HelpingAI/HelpingAI2-3B:Q4_K_M

Configure OpenClaw

# Install OpenClaw:
npm install -g openclaw@latest
# Register the local server and set it as the default model:
openclaw onboard --non-interactive --mode local \
  --auth-choice custom-api-key \
  --custom-base-url http://127.0.0.1:8080/v1 \
  --custom-model-id "HelpingAI/HelpingAI2-3B:Q4_K_M" \
  --custom-provider-id llama-cpp \
  --custom-compatibility openai \
  --custom-text-input \
  --accept-risk \
  --skip-health

Run OpenClaw

openclaw agent --local --agent main --message "Hello from Hugging Face"

Docker Model Runner
How to use HelpingAI/HelpingAI2-3B with Docker Model Runner:
```
docker model run hf.co/HelpingAI/HelpingAI2-3B:Q4_K_M
```

Lemonade

How to use HelpingAI/HelpingAI2-3B with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull HelpingAI/HelpingAI2-3B:Q4_K_M

Run and chat with the model

lemonade run user.HelpingAI2-3B-Q4_K_M

List all available models

lemonade list

Abhaykoul commited on Oct 31, 2024

Commit

529a3e4

verified ·

1 Parent(s): eb0d094

Update README.md

Browse files

Files changed (1) hide show

README.md +4 -4

README.md CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 license: other
 license_name: helpingai
-license_link: LICENSE
 pipeline_tag: text-generation
 language:
 - en
@@ -22,8 +22,8 @@ tags:
 [![GitHub Organization](https://img.shields.io/badge/GitHub-Organization-blue.svg)](https://github.com/HelpingAI)
 [![Hugging Face](https://img.shields.io/badge/🤗%20Hugging%20Face-Organization-yellow)](https://huggingface.co/OEvortex)
-[![Model License](https://img.shields.io/badge/License-HelpingAI-green.svg)](LICENSE)
-[![Discord](https://img.shields.io/discord/1234567890?color=7289da&label=Discord&logo=discord&logoColor=ffffff)](https://discord.gg/YweJwNqrnH)
 <a href="https://github.com/HelpingAI/community/discussions">
   <img src="https://img.shields.io/badge/Join-Community%20Discussion-blue?style=for-the-badge&logo=github" alt="Join Community Discussion">
@@ -34,7 +34,7 @@ tags:
 </div>
 <div align="center">
-  <img src="HelpingAI.png" alt="HelpingAI Logo" width="300px">
 </div>
 ---

 ---
 license: other
 license_name: helpingai
+license_link: https://huggingface.co/OEvortex/HelpingAI-3B-v3/blob/main/LICENSE.md
 pipeline_tag: text-generation
 language:
 - en
 [![GitHub Organization](https://img.shields.io/badge/GitHub-Organization-blue.svg)](https://github.com/HelpingAI)
 [![Hugging Face](https://img.shields.io/badge/🤗%20Hugging%20Face-Organization-yellow)](https://huggingface.co/OEvortex)
+[![Model License](https://img.shields.io/badge/License-HelpingAI-green.svg)](https://huggingface.co/OEvortex/HelpingAI-3B-v3/blob/main/LICENSE.md)
 <a href="https://github.com/HelpingAI/community/discussions">
   <img src="https://img.shields.io/badge/Join-Community%20Discussion-blue?style=for-the-badge&logo=github" alt="Join Community Discussion">
 </div>
 <div align="center">
+  <img src="https://huggingface.co/OEvortex/HelpingAI-3B/resolve/main/HelpingAI.png" alt="HelpingAI Logo" width="300px">
 </div>
 ---