nemoguardrails.library.hf_classifier.rail_config

Module Contents

Classes

Name	Description
`LocalHFClassifierConfig`	Configuration for a local HuggingFace Transformers pipeline classifier.
`RemoteHFClassifierConfig`	Configuration for a remote HuggingFace classifier (vLLM, KServe, FMS).
`_HFClassifierBase`	Shared fields for all HuggingFace classifier engines.

Functions

Name	Description
`build_config_spec`	-

Data

HFClassifierConfig

log

API

class nemoguardrails.library.hf_classifier.rail_config.LocalHFClassifierConfig()

Bases: _HFClassifierBase

Configuration for a local HuggingFace Transformers pipeline classifier.

engine

Literal['local'] = 'local'

parameters

Dict[str, Any]

task

Literal['text-classification', 'token-classification']

nemoguardrails.library.hf_classifier.rail_config.LocalHFClassifierConfig._validate_local() -> nemoguardrails.library.hf_classifier.rail_config.LocalHFClassifierConfig

class nemoguardrails.library.hf_classifier.rail_config.RemoteHFClassifierConfig()

Bases: _HFClassifierBase

Configuration for a remote HuggingFace classifier (vLLM, KServe, FMS).

_KNOWN_PARAMS

frozenset

api_key_env_var

Optional[str]

base_url

str

engine

Literal['vllm', 'kserve', 'fms']

parameters

Dict[str, Any]

nemoguardrails.library.hf_classifier.rail_config.RemoteHFClassifierConfig._validate_remote() -> nemoguardrails.library.hf_classifier.rail_config.RemoteHFClassifierConfig

class nemoguardrails.library.hf_classifier.rail_config._HFClassifierBase()

Bases: RailConfigBaseModel

Shared fields for all HuggingFace classifier engines.

blocked_labels

List[str]

model

str

threshold

float

nemoguardrails.library.hf_classifier.rail_config._HFClassifierBase._validate_common() -> nemoguardrails.library.hf_classifier.rail_config._HFClassifierBase

nemoguardrails.library.hf_classifier.rail_config.build_config_spec() -> nemoguardrails.manifests.config_schema.RailConfigSpec

nemoguardrails.library.hf_classifier.rail_config.HFClassifierConfig = Annotated[Union[LocalHFClassifierConfig, RemoteHFClassifierConfig], Discriminato...

nemoguardrails.library.hf_classifier.rail_config.log = logging.getLogger(__name__)