Instructions to use Yunhao-Feng/AdaGuard-8B with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use Yunhao-Feng/AdaGuard-8B with Transformers:

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

pipe = pipeline("text-generation", model="Yunhao-Feng/AdaGuard-8B")
messages = [
    {"role": "user", "content": "Who are you?"},
]
pipe(messages)

# pip install -U transformers accelerate
# Load model directly
from transformers import AutoTokenizer, AutoModelForCausalLM

tokenizer = AutoTokenizer.from_pretrained("Yunhao-Feng/AdaGuard-8B")
model = AutoModelForCausalLM.from_pretrained("Yunhao-Feng/AdaGuard-8B", device_map="auto")
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=256)
print(tokenizer.decode(outputs[0][inputs["input_ids"].shape[-1]:]))

Notebooks
Google Colab
Kaggle
Local Apps Settings

vLLM

How to use Yunhao-Feng/AdaGuard-8B with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/Yunhao-Feng/AdaGuard-8B

SGLang

How to use Yunhao-Feng/AdaGuard-8B 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 "Yunhao-Feng/AdaGuard-8B" \
    --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": "Yunhao-Feng/AdaGuard-8B",
		"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 "Yunhao-Feng/AdaGuard-8B" \
        --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": "Yunhao-Feng/AdaGuard-8B",
		"messages": [
			{
				"role": "user",
				"content": "What is the capital of France?"
			}
		]
	}'

Docker Model Runner
How to use Yunhao-Feng/AdaGuard-8B with Docker Model Runner:
```
docker model run hf.co/Yunhao-Feng/AdaGuard-8B
```

Add model card and metadata

by nielsr HF Staff - opened Sep 30

base: refs/heads/main

←

from: refs/pr/1

Discussion Files changed

+51

-0

nielsr

Sep 30

This PR adds a model card for AdaGuard: An Adaptive Guard Model with User-defined Policies. It includes the pipeline_tag metadata, links to the paper, project page, and code repository, and a usage example based on the official GitHub README.

Add model card and metadata8f73aff1

Yunhao-Feng

Owner Sep 30

due to the internet connection, we may need wait for few days...

nielsr

20 days ago

Thanks for the update. I checked the current model card and it now has a fuller AdaGuard description, paper link, usage information, and text-generation metadata. My older PR would overwrite that work, so I'm closing it.

nielsr changed pull request status to closed 20 days ago

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