Modelpublic

enguard/medium-guard-128m-xx-general-politeness-binary-intel

sourceHugging Facemitupdated 11mo agoView on Hugging Face

0likes12downloads

Model Card

enguard/medium-guard-128m-xx-general-politeness-binary-intel

This model is a fine-tuned Model2Vec classifier based on minishlab/potion-multilingual-128M for the general-politeness-binary found in the Intel/polite-guard dataset.

Installation

bash

pip install model2vec[inference]

Usage

python

from model2vec.inference import StaticModelPipeline

model = StaticModelPipeline.from_pretrained(
  "enguard/medium-guard-128m-xx-general-politeness-binary-intel"
)


# 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.

Field	Value
Classifies	general-politeness-binary
Base Model	minishlab/potion-multilingual-128M
Precision	0.9831
Recall	0.9901
F1	0.9866

Confusion Matrix

True \ Predicted	FAIL	PASS
FAIL	2507	25
PASS	43	7625

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

json

{
  "FAIL": {
    "precision": 0.9831372549019608,
    "recall": 0.9901263823064771,
    "f1-score": 0.9866194411648957,
    "support": 2532.0
  },
  "PASS": {
    "precision": 0.9967320261437909,
    "recall": 0.9943922796035473,
    "f1-score": 0.9955607781694739,
    "support": 7668.0
  },
  "accuracy": 0.9933333333333333,
  "macro avg": {
    "precision": 0.9899346405228758,
    "recall": 0.9922593309550122,
    "f1-score": 0.9910901096671848,
    "support": 10200.0
  },
  "weighted avg": {
    "precision": 0.993357324106113,
    "recall": 0.9933333333333333,
    "f1-score": 0.9933412227483374,
    "support": 10200.0
  }
}

</details>

<details> <summary>Sample Predictions</summary>

Text	True Label	Predicted Label
I appreciate your interest in our vegetarian options. I can provide you with a list of our current dishes that cater to your dietary preferences.	PASS	PASS
I understand you're concerned about the ski lessons, and I'll look into the options for rescheduling.	PASS	PASS
Our technical skills course will cover the essential topics in data analysis, including data visualization and statistical modeling. The course materials will be available on our learning platform.	PASS	PASS
Our buffet hours are from 11 AM to 9 PM. Please note that we have a limited selection of options available during the lunch break.	PASS	PASS
I'll look into your policy details and see what options are available to you.	PASS	PASS
I appreciate your interest in our vegetarian options. I can provide you with a list of our current dishes that cater to your dietary preferences.	PASS	PASS

</details>

<details> <summary>Prediction Speed Benchmarks</summary>

Dataset Size	Time (seconds)	Predictions/Second
1	0.0003	3446.43
1000	0.1092	9156.49
10000	1.1875	8420.85

</details>

Other model variants

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

Classifies	Model	Precision	Recall	F1
general-politeness-binary	enguard/tiny-guard-2m-en-general-politeness-binary-intel	0.9843	0.9889	0.9866
general-politeness-multiclass	enguard/tiny-guard-2m-en-general-politeness-multiclass-intel	0.9875	0.9704	0.9789
general-politeness-binary	enguard/tiny-guard-4m-en-general-politeness-binary-intel	0.9831	0.9878	0.9854
general-politeness-multiclass	enguard/tiny-guard-4m-en-general-politeness-multiclass-intel	0.9896	0.9783	0.9839
general-politeness-binary	enguard/tiny-guard-8m-en-general-politeness-binary-intel	0.9828	0.9905	0.9866
general-politeness-multiclass	enguard/tiny-guard-8m-en-general-politeness-multiclass-intel	0.9873	0.9795	0.9833
general-politeness-binary	enguard/small-guard-32m-en-general-politeness-binary-intel	0.9858	0.9889	0.9874
general-politeness-multiclass	enguard/small-guard-32m-en-general-politeness-multiclass-intel	0.9897	0.9862	0.9879
general-politeness-binary	enguard/medium-guard-128m-xx-general-politeness-binary-intel	0.9831	0.9901	0.9866
general-politeness-multiclass	enguard/medium-guard-128m-xx-general-politeness-multiclass-intel	0.9881	0.9870	0.9876

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}
}