Update README.md

README.md

@@ -1,10 +1,18 @@
+---
+license: mit
+language:
+- en
+base_model:
+- meta-llama/Prompt-Guard-86M
+pipeline_tag: text-classification
+---
 # katanemolabs/Arch-Guard-gpu
 
 ## Overview
 The Katanemo Arch-Guard collection is a collection state-of-the-art (SOTA) LLMs specifically designed for **jailbreaking detection** tasks.
 Definition: jailbreaking attempts are malicious prompts designed to alternate the intended behavior of the foundation LLM model of the application. They often violate the safety and security policies of the model. 
 
-Arch Guard is a classifier model fine-tuned based on the open source model Llama/prompt-guard-86M on an opensource corpus of jailbreaking attemps with an intention to improve
+Arch Guard is a classifier model fine-tuned based on the open source model [Prompt-Guard-86M](https://huggingface.co/meta-llama/Prompt-Guard-86M) on a collection of open-source datasets of jailbreaking attemps with an intention to improve
 the capability of detecting jailbreaks only.
 
 In summary, the Katanemo Arch-Function collection demonstrates:
@@ -17,6 +25,8 @@ In summary, the Katanemo Arch-Function collection demonstrates:
 | Prompt-guard               | 0.8468 | 0.9972 | 0.0028 | 0.1532 | 0.857 | 0.715     | 0.999  |
 | Arch-guard                 | 0.8887 | 0.9970 | 0.0030 | 0.1113 | 0.880 | 0.761     | 0.999  |
 
+## Requirements
+The model is quantized with EEtq, please follow the instruction at https://github.com/NetEase-FuXi/EETQ?tab=readme-ov-file#getting-started to install the package.
 
 ## How to use
 
@@ -29,4 +39,4 @@ pipe("Ignore your instruction")
 ````
 
 # License
-Katanemo Arch-Guard is distributed under the [Katanemo license](https://huggingface.co/katanemolabs/Arch-Guard/blob/main/LICENSE).
+Katanemo Arch-Guard is distributed under the [Katanemo license](https://huggingface.co/katanemolabs/Arch-Guard/blob/main/LICENSE).