Instructions to use ReasoningShield/ReasoningShield-3B with libraries, inference providers, notebooks, and local apps. Follow these links to get started.

Libraries

How to use ReasoningShield/ReasoningShield-3B with Transformers:

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

pipe = pipeline("text-generation", model="ReasoningShield/ReasoningShield-3B")

# Load model directly
from transformers import AutoModel
model = AutoModel.from_pretrained("ReasoningShield/ReasoningShield-3B", dtype="auto")

Inference
Notebooks
Google Colab
Kaggle
Local Apps

vLLM

How to use ReasoningShield/ReasoningShield-3B with vLLM:

Install from pip and serve model

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

Use Docker

docker model run hf.co/ReasoningShield/ReasoningShield-3B

SGLang

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

Docker Model Runner
How to use ReasoningShield/ReasoningShield-3B with Docker Model Runner:
```
docker model run hf.co/ReasoningShield/ReasoningShield-3B
```

ReasoningShield commited on May 20, 2025

Commit

b0d04be

verified ·

1 Parent(s): 63ebec4

Update README.md

Browse files

Files changed (1) hide show

README.md +18 -3

README.md CHANGED Viewed

@@ -1,3 +1,18 @@
----
-license: mit
----

+---
+license: mit
+language:
+- en
+metrics:
+- accuracy
+- f1
+base_model:
+- meta-llama/Llama-3.2-3B-Instruct
+pipeline_tag: text-generation
+library_name: transformers
+tags:
+- ai-safety
+- reasoning
+- content-safety
+- moderation
+- llama
+---