You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Replace `$TAG` with your desired image tag (e.g., `my-detector:latest`).
29
+
23
30
24
31
## Running locally
25
-
*`builtIn`: podman run -p 8080:8080 $BUILT_IN_IMAGE
26
32
27
-
## Examples
33
+
### Quick Start Commands
34
+
35
+
| Detector | Run Command | Notes |
36
+
|----------|-------------|-------|
37
+
|`builtIn`|`podman run -p 8080:8080 $BUILT_IN_IMAGE`| Ready to use |
38
+
|`huggingface`|`podman run -p 8000:8000 -e MODEL_DIR=/mnt/models/$MODEL_NAME -v $MODEL_PATH:/mnt/models/$MODEL_NAME:Z $HF_IMAGE`| Requires model download |
39
+
|`llm_judge`|`podman run -p 8000:8000 -e VLLM_BASE_URL=$LLM_SERVER_URL $LLM_JUDGE_IMAGE`| Requires OpenAI-compatible LLM server |
40
+
41
+
42
+
### Detailed Setup Instructions & Examples
28
43
29
-
- Check out [built-in detector examples](docs/builtin_examples.md) to see how to use the built-in detectors for file type validation and personally identifiable information (PII) detection
30
-
- Check out [Hugging Face detector examples](docs/hf_examples.md)to see how to use the Hugging Face detectors for detecting toxic content and prompt injection
31
-
- Check out [LLM Judge detector examples](docs/llm_judge_examples.md)to see how to use any OpenAI API compatible LLM for content assessment with built-in metrics and custom natural-language criteria
44
+
-**Built-in detector**: No additional setup required. Check out [built-in detector examples](docs/builtin_examples.md) to see how to use the built-in detectors for file type validation and personally identifiable information (PII) detection
45
+
-**Hugging Face detector**: Check out [Hugging Face detector examples](docs/hf_examples.md)for a complete setup and examples on how to use the Hugging Face detectors for detecting toxic content and prompt injection
46
+
-**LLM Judge detector**: Check out [LLM Judge detector examples](docs/llm_judge_examples.md)for a complete setup and examples on how to use any OpenAI API compatible LLM for content assessment with built-in metrics and custom natural-language criteria
32
47
33
48
## API
34
49
See [IBM Detector API](https://foundation-model-stack.github.io/fms-guardrails-orchestrator/?urls.primaryName=Detector+API)
0 commit comments