medium-guard-128m-xx-prompt-harmfulness-binary-moderation

enguard/medium-guard-128m-xx-prompt-harmfulness-binary-moderation

This model is a fine-tuned Model2Vec classifier based on minishlab/potion-multilingual-128M for the prompt-harmfulness-binary found in the enguard/multi-lingual-prompt-moderation dataset.

Installation

pip install model2vec[inference]

Usage

from model2vec.inference import StaticModelPipeline

model = StaticModelPipeline.from_pretrained(
  "enguard/medium-guard-128m-xx-prompt-harmfulness-binary-moderation"
)


# Supports single texts. Format input as a single text:
text = "Example sentence"

model.predict([text])
model.predict_proba([text])

Why should you use these models?

• Optimized for precision to reduce false positives.
• Extremely fast inference: up to x500 faster than SetFit.

This model variant

Below is a quick overview of the model variant and core metrics.

Confusion Matrix

<details> <summary><b>Full metrics (JSON)</b></summary>

{
  "FAIL": {
    "precision": 0.845679012345679,
    "recall": 0.8073664825046041,
    "f1-score": 0.8260787638967402,
    "support": 2715.0
  },
  "PASS": {
    "precision": 0.8146704464918497,
    "recall": 0.8517969618377177,
    "f1-score": 0.8328201412787538,
    "support": 2699.0
  },
  "accuracy": 0.8295160694495751,
  "macro avg": {
    "precision": 0.8301747294187644,
    "recall": 0.8295817221711609,
    "f1-score": 0.8294494525877469,
    "support": 5414.0
  },
  "weighted avg": {
    "precision": 0.8302205492427079,
    "recall": 0.8295160694495751,
    "f1-score": 0.8294394911878474,
    "support": 5414.0
  }
}

</details> <details> <summary><b>Sample Predictions</b></summary> </details> <details> <summary><b>Prediction Speed Benchmarks</b></summary> </details>

Other model variants

Below is a general overview of the best-performing models for each dataset variant.

Resources

• Awesome AI Guardrails: https://github.com/enguard-ai/awesome-ai-guardails
• Model2Vec: https://github.com/MinishLab/model2vec
• Docs: https://minish.ai/packages/model2vec/introduction

Citation

If you use this model, please cite Model2Vec:

@software{minishlab2024model2vec,
  author       = {Stephan Tulkens and {van Dongen}, Thomas},
  title        = {Model2Vec: Fast State-of-the-Art Static Embeddings},
  year         = {2024},
  publisher    = {Zenodo},
  doi          = {10.5281/zenodo.17270888},
  url          = {https://github.com/MinishLab/model2vec},
  license      = {MIT}
}