Skip to content

Pangolin

any_guardrail.guardrails.pangolin.pangolin

Pangolin

Bases: StandardGuardrail

Prompt injection detection encoder based models.

For more information, please see the model card:

Source code in src/any_guardrail/guardrails/pangolin/pangolin.py 
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
class Pangolin(StandardGuardrail):
    """Prompt injection detection encoder based models.

    For more information, please see the model card:

    - [Pangolin Base](https://huggingface.co/dcarpintero/pangolin-guard-base)
    """

    SUPPORTED_MODELS: ClassVar = ["dcarpintero/pangolin-guard-base"]

    def __init__(self, model_id: str | None = None, provider: StandardProvider | None = None) -> None:
        """Initialize the Pangolin guardrail."""
        self.model_id = default(model_id, self.SUPPORTED_MODELS)
        self.provider = provider or HuggingFaceProvider()
        self.provider.load_model(self.model_id)

    def _pre_processing(self, input_text: str) -> StandardPreprocessOutput:
        return self.provider.pre_process(input_text)

    def _inference(self, model_inputs: StandardPreprocessOutput) -> StandardInferenceOutput:
        return self.provider.infer(model_inputs)

    def _post_processing(self, model_outputs: StandardInferenceOutput) -> BinaryScoreOutput:
        return match_injection_label(model_outputs, PANGOLIN_INJECTION_LABEL, self.provider.model.config.id2label)  # type: ignore[attr-defined]
__init__(model_id=None, provider=None)

Initialize the Pangolin guardrail.

Source code in src/any_guardrail/guardrails/pangolin/pangolin.py 
22
23
24
25
26
def __init__(self, model_id: str | None = None, provider: StandardProvider | None = None) -> None:
    """Initialize the Pangolin guardrail."""
    self.model_id = default(model_id, self.SUPPORTED_MODELS)
    self.provider = provider or HuggingFaceProvider()
    self.provider.load_model(self.model_id)