Instructions to use OpceanAI/Yuuki-best with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use OpceanAI/Yuuki-best with Transformers:

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

pipe = pipeline("text-generation", model="OpceanAI/Yuuki-best", device_map="auto")

# Load model directly
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("OpceanAI/Yuuki-best")
model = AutoModelForCausalLM.from_pretrained("OpceanAI/Yuuki-best", device_map="auto")

llama-cpp-python

How to use OpceanAI/Yuuki-best with llama-cpp-python:

# !pip install llama-cpp-python

from llama_cpp import Llama

llm = Llama.from_pretrained(
	repo_id="OpceanAI/Yuuki-best",
	filename="yuuki-best-f32.gguf",
)

output = llm(
	"Once upon a time,",
	max_tokens=512,
	echo=True
)
print(output)

Notebooks
Google Colab
Kaggle
Local Apps Settings

llama.cpp

How to use OpceanAI/Yuuki-best 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 OpceanAI/Yuuki-best:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf OpceanAI/Yuuki-best:Q4_K_M

Install from WinGet (Windows)

winget install llama.cpp
# Start a local OpenAI-compatible server with a web UI:
llama serve -hf OpceanAI/Yuuki-best:Q4_K_M
# Run inference directly in the terminal:
llama cli -hf OpceanAI/Yuuki-best: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 OpceanAI/Yuuki-best:Q4_K_M
# Run inference directly in the terminal:
./llama-cli -hf OpceanAI/Yuuki-best: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 OpceanAI/Yuuki-best:Q4_K_M
# Run inference directly in the terminal:
./build/bin/llama-cli -hf OpceanAI/Yuuki-best:Q4_K_M

Use Docker

docker model run hf.co/OpceanAI/Yuuki-best:Q4_K_M

LM Studio
Jan

vLLM

How to use OpceanAI/Yuuki-best with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/OpceanAI/Yuuki-best:Q4_K_M

SGLang

How to use OpceanAI/Yuuki-best 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 "OpceanAI/Yuuki-best" \
    --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": "OpceanAI/Yuuki-best",
		"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 "OpceanAI/Yuuki-best" \
        --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": "OpceanAI/Yuuki-best",
		"prompt": "Once upon a time,",
		"max_tokens": 512,
		"temperature": 0.5
	}'

Ollama
How to use OpceanAI/Yuuki-best with Ollama:
```
ollama run hf.co/OpceanAI/Yuuki-best:Q4_K_M
```

Unsloth Studio

How to use OpceanAI/Yuuki-best 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 OpceanAI/Yuuki-best 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 OpceanAI/Yuuki-best to start chatting

Using HuggingFace Spaces for Unsloth

# No setup required
# Open https://huggingface.co/spaces/unsloth/studio in your browser
# Search for OpceanAI/Yuuki-best to start chatting

Atomic Chat new
Docker Model Runner
How to use OpceanAI/Yuuki-best with Docker Model Runner:
```
docker model run hf.co/OpceanAI/Yuuki-best:Q4_K_M
```

Lemonade

How to use OpceanAI/Yuuki-best with Lemonade:

Pull the model

# Download Lemonade from https://lemonade-server.ai/
lemonade pull OpceanAI/Yuuki-best:Q4_K_M

Run and chat with the model

lemonade run user.Yuuki-best-Q4_K_M

List all available models

lemonade list

aguitauwu commited on Feb 15

Commit

59e9f80

1 Parent(s): ba53607

Add GGUF quantized models (Q4_0, Q4_K_M, Q5_K_M, Q8_0, F32)

Browse files

Files changed (6) hide show

.gitattributes +1 -0
yuuki-best-f32.gguf +3 -0
yuuki-best-q4_0.gguf +3 -0
yuuki-best-q4_k_m.gguf +3 -0
yuuki-best-q5_k_m.gguf +3 -0
yuuki-best-q8_0.gguf +3 -0

.gitattributes CHANGED Viewed

@@ -33,3 +33,4 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text

 *.zip filter=lfs diff=lfs merge=lfs -text
 *.zst filter=lfs diff=lfs merge=lfs -text
 *tfevents* filter=lfs diff=lfs merge=lfs -text
+*.gguf filter=lfs diff=lfs merge=lfs -text

yuuki-best-f32.gguf ADDED Viewed

	@@ -0,0 +1,3 @@

+version https://git-lfs.github.com/spec/v1
+oid sha256:fd10400e41b71b4dd554706e9f028d12258a1751af76db42d11b03b89868adb7
+size 329422368

yuuki-best-q4_0.gguf ADDED Viewed

	@@ -0,0 +1,3 @@

+version https://git-lfs.github.com/spec/v1
+oid sha256:634d2b32b500399ca7844b24cb3b4e7d52407aa300f506735b91b675a3c8c94d
+size 60713344

yuuki-best-q4_k_m.gguf ADDED Viewed

	@@ -0,0 +1,3 @@

+version https://git-lfs.github.com/spec/v1
+oid sha256:a87d704e516a9e68f1b231bc5412c1b5ab579199375c07135328913be7d05cd0
+size 63256960

yuuki-best-q5_k_m.gguf ADDED Viewed

	@@ -0,0 +1,3 @@

+version https://git-lfs.github.com/spec/v1
+oid sha256:51e2d24fa211cba8b2b9b36f8a528d752e3a2dfb0ff0d79adb0dbf53770fedef
+size 68058496

yuuki-best-q8_0.gguf ADDED Viewed

	@@ -0,0 +1,3 @@

+version https://git-lfs.github.com/spec/v1
+oid sha256:611d329e0b05b1420cc93fb3a01bd7376a61c048c33fb3c92de90efc9040913f
+size 91294816