Update README.md

README.md

@@ -1,3 +1,73 @@
----
-license: mit
----
+---
+library_name: transformers
+tags:
+- prompt-injection
+- injection-detection
+- safety
+license: mit
+datasets:
+- RyanStudio/Mezzo-Prompt-Guard-Datasets
+base_model:
+- microsoft/deberta-v3-base
+pipeline_tag: text-classification
+---
+
+# Mezzo Prompt Guard Base Model Card
+<a href="https://discord.gg/sBMqepFV6m"><img src="https://discord.com/api/guilds/1386414999932506197/embed.png" alt="Discord Link" height="20"></a>
+
+
+The Mezzo Prompt Guard series aims to improve prompt injection and jailbreaking detection 
+
+Mezzo Prompt Guard Small was distilled from Mezzo Prompt Guard Base, and may offer greater performance and greater latency in some cases
+
+Mezzo Prompt Guard Tiny was further distilled from Mezzo Prompt Guard Small, and offers greater performance and latency in some cases as well
+
+
+To decide what models to use, I recommend the Base model for the most stability, Small for overall latency and performance, and Tiny if security is your top priority
+
+## Model Details
+
+### Model Description
+
+The Mezzo Prompt Guard series uses DeBERTa-v3 series as the base models
+
+I used [DeBERTa-v3-base](https://huggingface.co/microsoft/deberta-v3-base) as the base model for Mezzo Prompt Guard Base, 
+[DeBERTa-v3-small](https://huggingface.co/microsoft/deberta-v3-small) for Mezzo Prompt Guard Small,
+and [DeBERTa-v3-xsmall](https://huggingface.co/microsoft/deberta-v3-small) for Mezzo Prompt Guard Tiny
+
+Mezzo Prompt Guard aims to increase accuracy in detecting unsafe prompts compared to models like Llama Prompt Guard 2, and offers up to 2x better injection detection in some cases
+
+
+
+## Usage
+
+Mezzo Prompt Guard 2 labels prompts as 'safe' or 'unsafe' (safe prompts were categorized as 0, and unsafe 1 during the training process)
+
+
+# Performance Metrics
+
+## General Stats
+All tests were done on a RTX 5060ti 16GB with a 128 batch
+
+| Metric               | Mezzo Prompt Guard Base | Mezzo Prompt Guard Small | Mezzo Prompt Guard Tiny | Llama Prompt Guard 2 (86M) | ProtectAI DeBERTa base prompt injection v2 |
+|----------------------|------------------------|--------------------------|--------------------------|-----------------------------|--------------------------------------------|
+| Safe — Accuracy      | 0.9093                 | 0.9195                  | 0.8644                   | 0.9646 ✓                   | 0.9214                                     |
+| Safe — Recall        | 0.9093                 | 0.9195                  | 0.8644                   | 0.9646 ✓                   | 0.9214                                     |
+| Safe — F1            | 0.8366                 | 0.8437 ✓                | 0.8247                   | 0.8004                      | 0.8261                                     |
+| Injection — Accuracy | 0.6742                 | 0.6919                  | 0.7355 ✓                | 0.4050                      | 0.6213                                     |
+| Injection — Recall   | 0.6742                 | 0.6919                  | 0.7355 ✓                | 0.4050                      | 0.6213                                     |
+| Injection — F1       | 0.7350                 | 0.7437                  | 0.7444 ✓                | 0.5239                      | 0.7008                                     |
+
+Overall, the Mezzo Prompt Guard models are all better at detecting general, and more subtle prompt injections, offering almost up to 2x more coverage than Llama Prompt Guard 2
+
+False positives are flagged more often with ambiguous prompts, and it is recommended to adjust the threshold based on your needs
+
+
+## Model Information
+- **Dataset:** Mezzo Prompt Guard was trained with a large amount of public datasets, allowing it to detect well known attack patterns, as well as accounting for more modern attack methods
+
+
+# Limitations
+- Mezzo Prompt Guard may flag safe messages as unsafe occasionally, I recommend increasing the threshold for unsafe messages to 0.7 - 0.8 for increased accuracy
+- More sophisticated attacks outside of its training data may not be able to be detected
+- As the base model used (DeBERTa-v3) was primarily desgined for english, there may be limitations to its accuracy in multilingual contexts