Skip to content

Commit 6389030

Browse files
committed
📝 added the initial README.md to describe the prupose of the repo
1 parent bcec2da commit 6389030

File tree

2 files changed

+16
-33
lines changed

2 files changed

+16
-33
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Detectors for the FMS Guardrails Orchestrator
2+
3+
[FMS Guardrails Orchestrator](https://github.com/foundation-model-stack/fms-guardrails-orchestrator) is an open source project led by IBM which provides a server for invocation of detectors on text generation input and output, and standalone detections.
4+
5+
This repository is intended to provide a collection of detectors that are supported by [the TrustyAI team](https://github.com/trustyai-explainability).
6+
7+
## Detectors
8+
9+
At the moment, the following detectors are supported:
10+
11+
- `huggingface` -- a generic detector class that is intended to be compatible with any [AutoModelForSequenceClassification](https://huggingface.co/docs/transformers/en/model_doc/auto#transformers.AutoModelForSequenceClassification) or a specific kind of [AutoModelForCausalLM](https://huggingface.co/docs/transformers/en/model_doc/auto#transformers.AutoModelForCausalLM), namely [GraniteForCausalLM](https://github.com/ibm-granite/granite-guardian); this detector exposes `/api/v1/text/contents` and thus, could be configured to be a detector of type: `text_contents` within the FMS Guardrails Orchestrator framework. This detector is also intended to be deployed as a [KServe](https://github.com/kserve/kserve) inference service.
12+
13+
14+
15+
16+

requirements.txt

Lines changed: 0 additions & 33 deletions
This file was deleted.

0 commit comments

Comments
 (0)