Instructions to use oxyapi/oxy-1-small with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use oxyapi/oxy-1-small with Transformers:

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

pipe = pipeline("text-generation", model="oxyapi/oxy-1-small")
messages = [
    {"role": "user", "content": "Who are you?"},
]
pipe(messages)

# Load model directly
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("oxyapi/oxy-1-small")
model = AutoModelForCausalLM.from_pretrained("oxyapi/oxy-1-small")
messages = [
    {"role": "user", "content": "Who are you?"},
]
inputs = tokenizer.apply_chat_template(
	messages,
	add_generation_prompt=True,
	tokenize=True,
	return_dict=True,
	return_tensors="pt",
).to(model.device)

outputs = model.generate(**inputs, max_new_tokens=40)
print(tokenizer.decode(outputs[0][inputs["input_ids"].shape[-1]:]))

Inference
Notebooks
Google Colab
Kaggle
Local Apps

vLLM

How to use oxyapi/oxy-1-small 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"
# 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",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Use Docker

docker model run hf.co/oxyapi/oxy-1-small

SGLang

How to use oxyapi/oxy-1-small 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" \
    --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",
		"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" \
        --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",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Docker Model Runner
How to use oxyapi/oxy-1-small with Docker Model Runner:
```
docker model run hf.co/oxyapi/oxy-1-small
```

Hi，thanks for your guys contribution ,and my local host can't run it

by baiall - opened Dec 2, 2024

Discussion

baiall

Dec 2, 2024

So i wanna to know where is your apply for the API interface to experience it at the official website

SketchyAI

Oxygen org Dec 2, 2024

Hi baiall,

We provide a free endpoint:

This is the endpoint used for the demo space :

https://app.oxyapi.uk/free/v1/chat/completions

We use same OpenAI format.

Thank you, have a nice day !

baiall

Dec 2, 2024

Appreciate it ! So is that dosen't reqire any API key or some secret cod? just directly to copy that URL that so ?

TornadoAI

Oxygen org Dec 2, 2024

Yes exactly no need for API key or if it's required put anything! This is also the endpoint used in the space demo if anyone has the eye haha

TornadoAI changed discussion status to closed Dec 2, 2024

Upload images, audio, and videos by dragging in the text input, pasting, or clicking here.

Tap or paste here to upload images

· Sign up or log in to comment