Instructions to use jdopensource/JoyAI-LLM-Flash-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use jdopensource/JoyAI-LLM-Flash-GGUF with Transformers:

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

pipe = pipeline("text-generation", model="jdopensource/JoyAI-LLM-Flash-GGUF")
messages = [
    {"role": "user", "content": "Who are you?"},
]
pipe(messages)

# Load model directly
from transformers import AutoModel
model = AutoModel.from_pretrained("jdopensource/JoyAI-LLM-Flash-GGUF", device_map="auto")

Notebooks
Google Colab
Kaggle
Local Apps Settings

llama.cpp

How to use jdopensource/JoyAI-LLM-Flash-GGUF 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 jdopensource/JoyAI-LLM-Flash-GGUF:IQ3_XS
# Run inference directly in the terminal:
llama cli -hf jdopensource/JoyAI-LLM-Flash-GGUF:IQ3_XS

Install from WinGet (Windows)

winget install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama serve -hf jdopensource/JoyAI-LLM-Flash-GGUF:IQ3_XS
# Run inference directly in the terminal:
llama cli -hf jdopensource/JoyAI-LLM-Flash-GGUF:IQ3_XS

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 jdopensource/JoyAI-LLM-Flash-GGUF:IQ3_XS
# Run inference directly in the terminal:
./llama-cli -hf jdopensource/JoyAI-LLM-Flash-GGUF:IQ3_XS

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 jdopensource/JoyAI-LLM-Flash-GGUF:IQ3_XS
# Run inference directly in the terminal:
./build/bin/llama-cli -hf jdopensource/JoyAI-LLM-Flash-GGUF:IQ3_XS

Use Docker

docker model run hf.co/jdopensource/JoyAI-LLM-Flash-GGUF:IQ3_XS

LM Studio
Jan

vLLM

How to use jdopensource/JoyAI-LLM-Flash-GGUF with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/jdopensource/JoyAI-LLM-Flash-GGUF:IQ3_XS

SGLang

How to use jdopensource/JoyAI-LLM-Flash-GGUF 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 "jdopensource/JoyAI-LLM-Flash-GGUF" \
    --host 0.0.0.0 \
    --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "jdopensource/JoyAI-LLM-Flash-GGUF",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

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 "jdopensource/JoyAI-LLM-Flash-GGUF" \
        --host 0.0.0.0 \
        --port 30000
# Call the server using curl (OpenAI-compatible API):
curl -X POST "http://localhost:30000/v1/chat/completions" \
	-H "Content-Type: application/json" \
	--data '{
		"model": "jdopensource/JoyAI-LLM-Flash-GGUF",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Ollama
How to use jdopensource/JoyAI-LLM-Flash-GGUF with Ollama:
```
ollama run hf.co/jdopensource/JoyAI-LLM-Flash-GGUF:IQ3_XS
```
Unsloth Desktop

How to use jdopensource/JoyAI-LLM-Flash-GGUF with Pi:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf jdopensource/JoyAI-LLM-Flash-GGUF:IQ3_XS

Configure the model in Pi

# Install Pi:
npm install -g @earendil-works/pi-coding-agent
# Add to ~/.pi/agent/models.json:
{
  "providers": {
    "llama-cpp": {
      "baseUrl": "http://localhost:8080/v1",
      "api": "openai-completions",
      "apiKey": "none",
      "models": [
        {
          "id": "jdopensource/JoyAI-LLM-Flash-GGUF:IQ3_XS"
        }
      ]
    }
  }
}

Run Pi

# Start Pi in your project directory:
pi

Docker Model Runner
How to use jdopensource/JoyAI-LLM-Flash-GGUF with Docker Model Runner:
```
docker model run hf.co/jdopensource/JoyAI-LLM-Flash-GGUF:IQ3_XS
```

Lemonade

How to use jdopensource/JoyAI-LLM-Flash-GGUF with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull jdopensource/JoyAI-LLM-Flash-GGUF:IQ3_XS

Run and chat with the model

lemonade run user.JoyAI-LLM-Flash-GGUF-IQ3_XS

List all available models

lemonade list

Hermes Agent

How to use jdopensource/JoyAI-LLM-Flash-GGUF with Hermes Agent:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf jdopensource/JoyAI-LLM-Flash-GGUF:IQ3_XS

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 jdopensource/JoyAI-LLM-Flash-GGUF:IQ3_XS

Run Hermes

hermes

Atomic Chat

OpenClaw

How to use jdopensource/JoyAI-LLM-Flash-GGUF with OpenClaw:

Start the llama.cpp server

# Install llama.cpp:
brew install llama.cpp
# Start a local OpenAI-compatible server:
llama serve -hf jdopensource/JoyAI-LLM-Flash-GGUF:IQ3_XS

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 "jdopensource/JoyAI-LLM-Flash-GGUF:IQ3_XS" \
  --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"

Mingke977 commited on May 14

Commit

f995fe3

verified ·

1 Parent(s): c63bb59

Upload LICENSE

Browse files

Files changed (1) hide show

LICENSE +28 -0

LICENSE ADDED Viewed

	@@ -0,0 +1,28 @@

+Modified MIT License
+Copyright (c) 2026 JD AI
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+We offer you a license similar to the MIT License. In the event that the Software
+(or any derivative works thereof) is used for any of your commercial products or
+services that either have more than 100 million monthly active users or generate
+more than 20 million US dollars (or equivalent in other currencies) in monthly
+revenue, you are required to clearly display "JoyAI-LLM" on the user interface
+of such product or service.