Instructions to use oxyapi/oxy-1-small-GGUF with libraries, inference providers, notebooks, and local apps. Follow these links to get started.
- Libraries
- Transformers
How to use oxyapi/oxy-1-small-GGUF with Transformers:
# Use a pipeline as a high-level helper from transformers import pipeline pipe = pipeline("text-generation", model="oxyapi/oxy-1-small-GGUF") messages = [ {"role": "user", "content": "Who are you?"}, ] pipe(messages)# Load model directly from transformers import AutoModel model = AutoModel.from_pretrained("oxyapi/oxy-1-small-GGUF", device_map="auto") - Notebooks
- Google Colab
- Kaggle
- Local Apps Settings
- llama.cpp
How to use oxyapi/oxy-1-small-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 oxyapi/oxy-1-small-GGUF:Q4_K_M # Run inference directly in the terminal: llama cli -hf oxyapi/oxy-1-small-GGUF:Q4_K_M
Install from WinGet (Windows)
winget install llama.cpp # Start a local OpenAI-compatible server with a web UI: llama serve -hf oxyapi/oxy-1-small-GGUF:Q4_K_M # Run inference directly in the terminal: llama cli -hf oxyapi/oxy-1-small-GGUF: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 oxyapi/oxy-1-small-GGUF:Q4_K_M # Run inference directly in the terminal: ./llama-cli -hf oxyapi/oxy-1-small-GGUF: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 oxyapi/oxy-1-small-GGUF:Q4_K_M # Run inference directly in the terminal: ./build/bin/llama-cli -hf oxyapi/oxy-1-small-GGUF:Q4_K_M
Use Docker
docker model run hf.co/oxyapi/oxy-1-small-GGUF:Q4_K_M
- LM Studio
- Jan
- vLLM
How to use oxyapi/oxy-1-small-GGUF with vLLM:
Install from pip and serve model
# Install vLLM from pip: pip install vllm # Start the vLLM server: vllm serve "oxyapi/oxy-1-small-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": "oxyapi/oxy-1-small-GGUF", "messages": [ { "role": "user", "content": "What is the capital of France?" } ] }'Use Docker
docker model run hf.co/oxyapi/oxy-1-small-GGUF:Q4_K_M
- SGLang
How to use oxyapi/oxy-1-small-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 "oxyapi/oxy-1-small-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": "oxyapi/oxy-1-small-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 "oxyapi/oxy-1-small-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": "oxyapi/oxy-1-small-GGUF", "messages": [ { "role": "user", "content": "What is the capital of France?" } ] }' - Ollama
How to use oxyapi/oxy-1-small-GGUF with Ollama:
ollama run hf.co/oxyapi/oxy-1-small-GGUF:Q4_K_M
- Unsloth Desktop
- Docker Model Runner
How to use oxyapi/oxy-1-small-GGUF with Docker Model Runner:
docker model run hf.co/oxyapi/oxy-1-small-GGUF:Q4_K_M
- Lemonade
How to use oxyapi/oxy-1-small-GGUF with Lemonade:
Pull the model
# Download Lemonade from https://lemonade-server.ai/ lemonade pull oxyapi/oxy-1-small-GGUF:Q4_K_M
Run and chat with the model
lemonade run user.oxy-1-small-GGUF-Q4_K_M
List all available models
lemonade list
- Atomic Chat
| license: apache-2.0 | |
| language: | |
| - en | |
| pipeline_tag: text-generation | |
| tags: | |
| - role-play | |
| - fine-tuned | |
| - qwen2.5 | |
| base_model: | |
| - oxyapi/oxy-1-small | |
| library_name: transformers | |
|  | |
| ## Model Details | |
| - **Model Name**: Oxy 1 Small | |
| - **Model ID**: [oxyapi/oxy-1-small](https://huggingface.co/oxyapi/oxy-1-small) | |
| - **Base Model**: [Qwen/Qwen2.5-14B-Instruct](https://huggingface.co/Qwen/Qwen2-1.5B) | |
| - **Model Type**: Chat Completions | |
| - **Prompt Format**: ChatML | |
| - **License**: Apache-2.0 | |
| - **Language**: English | |
| - **Tokenizer**: [Qwen/Qwen2.5-14B-Instruct](https://huggingface.co/Qwen/Qwen2.5-14B-Instruct) | |
| - **Max Input Tokens**: 32,768 | |
| - **Max Output Tokens**: 8,192 | |
| ## License | |
| This model is licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0). | |
| ## Citation | |
| If you find Oxy 1 Small useful in your research or applications, please cite it as: | |
| ``` | |
| @misc{oxy1small2024, | |
| title={Oxy 1 Small: A Fine-Tuned Qwen2.5-14B-Instruct Model for Role-Play}, | |
| author={Oxygen (oxyapi)}, | |
| year={2024}, | |
| howpublished={\url{https://huggingface.co/oxyapi/oxy-1-small}}, | |
| } | |
| ``` |