Downloads · 30 days
513
2% of all-time downloads
Llama-Guard-3-8B-GGUF
QuantFactory/Llama-Guard-3-8B-GGUF
Llama-Guard-3-8B-GGUF is a text generation model from QuantFactory. Use it when you need the model to write or continue text. The card lists the license as llama3.1.
All-time downloads
21.2K
Public
Repo size
72.7 GB
Likes
2
Public
Repo makeup
Click a slice to open those files.
.gguf72.7 GB · 100%
At a glance
- Task
- Text Generation
- License
- llama3.1
- Access
- Public
- Created
- Jul 30, 2024
- Updated
- Jul 30, 2024
- SHA
- c38e65dc
Try a prompt
Model card
From the Hugging Face model README
QuantFactory/Llama-Guard-3-8B-GGUF
This is quantized version of meta-llama/Llama-Guard-3-8B created using llama.cpp
Original Model Card
Model Details
Llama Guard 3 is a Llama-3.1-8B pretrained model, fine-tuned for content safety classification. Similar to previous versions, it can be used to classify content in both LLM inputs (prompt classification) and in LLM responses (response classification). It acts as an LLM – it generates text in its output that indicates whether a given prompt or response is safe or unsafe, and if unsafe, it also lists the content categories violated.
Llama Guard 3 was aligned to safeguard against the MLCommons standardized hazards taxonomy and designed to support Llama 3.1 capabilities. Specifically, it provides content moderation in 8 languages, and was optimized to support safety and security for search and code interpreter tool calls.
Below is a response classification example for Llama Guard 3.
<p align="center"> <img src="llama_guard_3_figure.png" width="800"/> </p>In order to produce classifier scores, we look at the probability for the first token, and use that as the “unsafe” class probability. We can then apply score thresholding to make binary decisions.
Hazard Taxonomy and Policy
The model is trained to predict safety labels on the 14 categories shown below, based on the MLCommons taxonomy of 13 hazards, as well as an additional category for Code Interpreter Abuse for tool calls use cases
<table align="center"> <thead> <tr> <th colspan="2">Hazard categories</th> </tr> </thead> <tbody> <tr> <td>S1: Violent Crimes</td> <td>S2: Non-Violent Crimes</td> </tr> <tr> <td>S3: Sex-Related Crimes</td> <td>S4: Child Sexual Exploitation</td> </tr> <tr> <td>S5: Defamation</td> <td>S6: Specialized Advice</td> </tr> <tr> <td>S7: Privacy</td> <td>S8: Intellectual Property</td> </tr> <tr> <td>S9: Indiscriminate Weapons</td> <td>S10: Hate</td> </tr> <tr> <td>S11: Suicide & Self-Harm</td> <td>S12: Sexual Content</td> </tr> <tr> <td>S13: Elections</td> <td>S14: Code Interpreter Abuse</td> </tr> </tbody> </table>S1 - Violent Crimes
Responses that enable, encourage, or endorse the commission of violent crimes, including: (1) unlawful violence toward people (ex: terrorism, genocide, murder, hate-motivated violent crimes, child abuse, assault, battery, kidnapping) and (2) unlawful violence toward animals (ex: animal abuse)
S2 - Non-Violent Crimes
Responses that enable, encourage, or endorse the commission of non-violent crimes, including: (1) personal crimes (ex: labor trafficking, threats, intimidation, hate-motivated non-violent crimes), (2) financial crimes (ex: fraud, scams, money laundering), (3) property crimes (ex: theft, arson, vandalism), (4) drug crimes (ex: creating or using regulated substances), (5) weapons crimes (ex: producing unlicensed firearms), and (6) cyber crimes (ex: hacking)
S3 - Sex-Related Crimes
Responses that enable, encourage, or endorse the commission of sex-related crimes, including: (1) sex trafficking, (2) sexual assault (ex: rape), (3) sexual harassment (physical, verbal, or visual), and (4) prostitution
S4 - Child Sexual Exploitation
Responses that contain, describe, enable, encourage, or endorse the sexual abuse of children
S5 - Defamation
Responses that are both verifiably false and likely to injure a living person’s reputation
S6 - Specialized Advice
Responses that contain specialized financial, medical, or legal advice, or that indicate dangerous activities or objects are safe
S7 - Privacy
Responses that contain sensitive, nonpublic personal information that could undermine someone’s physical, digital, or financial security
S8 - Intellectual Property
Responses that may violate the intellectual property rights of any third party
S9 - Indiscriminate Weapons
Responses that enable, encourage, or endorse the creation of indiscriminate weapons, including: (1) chemical weapons (ex: nerve gas), (2) biological weapons (ex: anthrax), (3) radiological weapons (ex: cobalt bombs), (4) nuclear weapons (ex: fission bombs), and (5) high-yield explosive weapons (ex: cluster munitions)
S10 - Hate
Responses that demean or dehumanize people on the basis of their sensitive, personal characteristics (i.e., race, color, ethnicity, national origin, disability, religious affiliation, caste, sexual orientation, sex, gender identity, and/or serious disease)
S11 - Suicide & Self-Harm
Responses that enable, encourage, or endorse acts of intentional self-harm, including: (1) suicide, (2) self-injury (ex: cutting), and (3) disordered eating
S12 - Sexual Content
Responses that contain erotica
S13 - Elections
Responses that contain factually incorrect information about electoral systems and processes, including in the time, place, or manner of voting in civic elections
S14 - Code Interpreter Abuse
Responses that seek to abuse code interpreters, including those that enable denial of service attacks, container escapes or privilege escalation exploits
Supported languages
Llama Guard 3 supports content safety for the following languages : English, French, German, Hindi, Italian, Portuguese, Spanish, Thai.
Usage
[!IMPORTANT]
This repository corresponds to half-precision version of the model. A 8-bit precision version is also provided, please visit meta-llama/Llama-Guard-3-8B-INT8.
Llama Guard 3 can be directly used with transformers. It is only supported since transformers version 4.43.
import torch
from transformers import AutoTokenizer, AutoModelForCausalLM
model_id = "meta-llama/Llama-Guard-3-8B"
device = "cuda"
dtype = torch.bfloat16
tokenizer = AutoTokenizer.from_pretrained(model_id)
model = AutoModelForCausalLM.from_pretrained(model_id, torch_dtype=dtype, device_map=device)
def moderate(chat):
input_ids = tokenizer.apply_chat_template(chat, return_tensors="pt").to(device)
output = model.generate(input_ids=input_ids, max_new_tokens=100, pad_token_id=0)
prompt_len = input_ids.shape[-1]
return tokenizer.decode(output[0][prompt_len:], skip_special_tokens=True)
moderate([
{"role": "user", "content": "I forgot how to kill a process in Linux, can you help?"},
{"role": "assistant", "content": "Sure! To kill a process in Linux, you can use the kill command followed by the process ID (PID) of the process you want to terminate."},
])
Training Data
We use the English data used by Llama Guard [1], which are obtained by getting Llama 2 and Llama 3 generations on prompts from the hh-rlhf dataset [2]. In order to scale training data for new categories and new capabilities such as multilingual and tool use, we collect additional human and synthetically generated data. Similar to the English data, the multilingual data are Human-AI conversation data that are either single-turn or multi-turn. To reduce the model’s false positive rate, we curate a set of multilingual benign prompt and response data where LLMs likely reject the prompts.
For the tool use capability, we consider search tool calls and code interpreter abuse. To develop training data for search tool use, we use Llama3 to generate responses to a collected and synthetic set of prompts. The generations are based on the query results obtained from the Brave Search API. To develop synthetic training data to detect code interpreter attacks, we use an LLM to generate safe and unsafe prompts. Then, we use a non-safety-tuned LLM to generate code interpreter completions that comply with these instructions. For safe data, we focus on data close to the boundary of what would be considered unsafe, to minimize false positives on such borderline examples.
Evaluation
Note on evaluations: As discussed in the original Llama Guard paper, comparing model performance is not straightforward as each model is built on its own policy and is expected to perform better on an evaluation dataset with a policy aligned to the model. This highlights the need for industry standards. By aligning the Llama Guard family of models with the Proof of Concept MLCommons taxonomy of hazards, we hope to drive adoption of industry standards like this and facilitate collaboration and transparency in the LLM safety and content evaluation space.
In this regard, we evaluate the performance of Llama Guard 3 on MLCommons hazard taxonomy and compare it across languages with Llama Guard 2 [3] on our internal test. We also add GPT4 as baseline with zero-shot prompting using MLCommons hazard taxonomy.
Tables 1, 2, and 3 show that Llama Guard 3 improves over Llama Guard 2 and outperforms GPT4 in English, multilingual, and tool use capabilities. Noteworthily, Llama Guard 3 achieves better performance with much lower false positive rates. We also benchmark Llama Guard 3 in the OSS dataset XSTest [4] and observe that it achieves the same F1 score but a lower false positive rate compared to Llama Guard 2.
<div align="center"> <small> Table 1: Comparison of performance of various models measured on our internal English test set for MLCommons hazard taxonomy (response classification).</small>| F1 ↑ | AUPRC ↑ | False Positive<br>Rate ↓ | |
|---|---|---|---|
| Llama Guard 2 | 0.877 | 0.927 | 0.081 |
| Llama Guard 3 | 0.939 | 0.985 | 0.040 |
| GPT4 | 0.805 | N/A | 0.152 |
Application
As outlined in the Llama 3 paper, Llama Guard 3 provides industry leading system-level safety performance and is recommended to be deployed along with Llama 3.1. Note that, while deploying Llama Guard 3 will likely improve the safety of your system, it might increase refusals to benign prompts (False Positives). Violation rate improvement and impact on false positives as measured on internal benchmarks are provided in the Llama 3 paper.
Quantization
We are committed to help the community deploy Llama systems responsibly. We provide a quantized version of Llama Guard 3 to lower the deployment cost. We used int 8 implementation integrated into the hugging face ecosystem, reducing the checkpoint size by about 40% with very small impact on model performance. In Table 5, we observe that the performance quantized model is comparable to the original model.
<table align="center"> <small><center>Table 5: Impact of quantization on Llama Guard 3 performance.</center></small> <tbody> <tr> <td rowspan="2"><br /> <p><span>Task</span></p> </td> <td rowspan="2"><br /> <p><span>Capability</span></p> </td> <td colspan="4"> <p><center><span>Non-Quantized</span></center></p> </td> <td colspan="4"> <p><center><span>Quantized</span></center></p> </td> </tr> <tr> <td> <p><span>Precision</span></p> </td> <td> <p><span>Recall</span></p> </td> <td> <p><span>F1</span></p> </td> <td> <p><span>FPR</span></p> </td> <td> <p><span>Precision</span></p> </td> <td> <p><span>Recall</span></p> </td> <td> <p><span>F1</span></p> </td> <td> <p><span>FPR</span></p> </td> </tr> <tr> <td rowspan="3"> <p><span>Prompt Classification</span></p> </td> <td> <p><span>English</span></p> </td> <td> <p><span>0.952</span></p> </td> <td> <p><span>0.943</span></p> </td> <td> <p><span>0.947</span></p> </td> <td> <p><span>0.057</span></p> </td> <td> <p><span>0.961</span></p> </td> <td> <p><span>0.939</span></p> </td> <td> <p><span>0.950</span></p> </td> <td> <p><span>0.045</span></p> </td> </tr> <tr> <td> <p><span>Multilingual</span></p> </td> <td> <p><span>0.901</span></p> </td> <td> <p><span>0.899</span></p> </td> <td> <p><span>0.900</span></p> </td> <td> <p><span>0.054</span></p> </td> <td> <p><span>0.906</span></p> </td> <td> <p><span>0.892</span></p> </td> <td> <p><span>0.899</span></p> </td> <td> <p><span>0.051</span></p> </td> </tr> <tr> <td> <p><span>Tool Use</span></p> </td> <td> <p><span>0.884</span></p> </td> <td> <p><span>0.958</span></p> </td> <td> <p><span>0.920</span></p> </td> <td> <p><span>0.126</span></p> </td> <td> <p><span>0.876</span></p> </td> <td> <p><span>0.946</span></p> </td> <td> <p><span>0.909</span></p> </td> <td> <p><span>0.134</span></p> </td> </tr> <tr> <td rowspan="3"> <p><span>Response Classification</span></p> </td> <td> <p><span>English</span></p> </td> <td> <p><span>0.947</span></p> </td> <td> <p><span>0.931</span></p> </td> <td> <p><span>0.939</span></p> </td> <td> <p><span>0.040</span></p> </td> <td> <p><span>0.947</span></p> </td> <td> <p><span>0.925</span></p> </td> <td> <p><span>0.936</span></p> </td> <td> <p><span>0.040</span></p> </td> </tr> <tr> <td> <p><span>Multilingual</span></p> </td> <td> <p><span>0.929</span></p> </td> <td> <p><span>0.805</span></p> </td> <td> <p><span>0.862</span></p> </td> <td> <p><span>0.033</span></p> </td> <td> <p><span>0.931</span></p> </td> <td> <p><span>0.785</span></p> </td> <td> <p><span>0.851</span></p> </td> <td> <p><span>0.031</span></p> </td> </tr> <tr> <td> <p><span>Tool Use</span></p> </td> <td> <p><span>0.774</span></p> </td> <td> <p><span>0.884</span></p> </td> <td> <p><span>0.825</span></p> </td> <td> <p><span>0.176</span></p> </td> <td> <p><span>0.793</span></p> </td> <td> <p><span>0.865</span></p> </td> <td> <p><span>0.827</span></p> </td> <td> <p><span>0.155</span></p> </td> </tr> </tbody> </table>Get started
Llama Guard 3 is available by default on Llama 3.1 reference implementations. You can learn more about how to configure and customize using Llama Recipes shared on our Github repository.
Limitations
There are some limitations associated with Llama Guard 3. First, Llama Guard 3 itself is an LLM fine-tuned on Llama 3.1. Thus, its performance (e.g., judgments that need common sense knowledge, multilingual capability, and policy coverage) might be limited by its (pre-)training data.
Some hazard categories may require factual, up-to-date knowledge to be evaluated (for example, S5: Defamation, S8: Intellectual Property, and S13: Elections) . We believe more complex systems should be deployed to accurately moderate these categories for use cases highly sensitive to these types of hazards, but Llama Guard 3 provides a good baseline for generic use cases.
Lastly, as an LLM, Llama Guard 3 may be susceptible to adversarial attacks or prompt injection attacks that could bypass or alter its intended use. Please feel free to report vulnerabilities and we will look to incorporate improvements in future versions of Llama Guard.
References
[1] Llama Guard: LLM-based Input-Output Safeguard for Human-AI Conversations
[2] Training a Helpful and Harmless Assistant with Reinforcement Learning from Human Feedback
[4] XSTest: A Test Suite for Identifying Exaggerated Safety Behaviors in Large Language Models
- Task
- Text Generation
- License
- llama3.1
- Languages
- en
- Created
- Jul 30, 2024
- Updated
- Jul 30, 2024