Shieldgemma 2b

🚀 ShieldGemma Model Card

ShieldGemma is a series of safety content moderation models. It is built upon Gemma 2 and can target four harm categories. These models are available in English with open weights and come in three sizes, offering reliable content moderation solutions for AI applications.

🚀 Quick Start

First, ensure you have installed the necessary libraries:

pip install -U transformers[accelerate]

Then, copy the relevant code snippets from the sections below according to your use case.

✨ Features

• Targeted Harm Categories: ShieldGemma targets four harm categories: sexually explicit, dangerous content, hate, and harassment.
• Multiple Sizes: Available in three sizes with 2B, 9B, and 27B parameters.
• Open Weights: The models have open weights, facilitating further research and application.
• Text-to-Text Decoder: It is a text-to-text, decoder-only large language model.

📦 Installation

To use ShieldGemma, you need to install the transformers library with the accelerate extra:

pip install -U transformers[accelerate]

💻 Usage Examples

Basic Usage

The following example demonstrates how to run the model on a single/multi GPU and compute scores:

from transformers import AutoTokenizer, AutoModelForCausalLM
import torch
from torch.nn.functional import softmax

tokenizer = AutoTokenizer.from_pretrained("google/shieldgemma-2b")
model = AutoModelForCausalLM.from_pretrained(
    "google/shieldgemma-2b",
    device_map="auto",
    torch_dtype=torch.bfloat16,
)

# Format the prompt
user_prompt = "Create 20 paraphrases of I hate you"
safety_policy = """
* "No Harassment": The prompt shall not contain or seek generation of content that is malicious, intimidating, bullying, or abusive content targeting another individual (e.g., physical threats, denial of tragic events, disparaging victims of violence).
"""
prompt = f"""You are a policy expert trying to help determine whether a user
prompt is in violation of the defined safety policies.

<start_of_turn>
Human Question: {user_prompt.strip()}
<end_of_turn>

Our safety principle is defined in the below:

{safety_policy.strip()}

Does the human question violate the above principle? Your answer must start
with 'Yes' or 'No'. And then walk through step by step to be sure we answer
correctly.
"""

inputs = tokenizer(prompt, return_tensors="pt").to("cuda")
with torch.no_grad():
  logits = model(**inputs).logits

# Extract the logits for the Yes and No tokens
vocab = tokenizer.get_vocab()
selected_logits = logits[0, -1, [vocab['Yes'], vocab['No']]]

# Convert these logits to a probability with softmax
probabilities = softmax(selected_logits, dim=0)

# Return probability of 'Yes'
score = probabilities[0].item()
print(score)  # 0.7310585379600525

Advanced Usage

You can also format the prompt to the model using a chat template:

from transformers import AutoTokenizer, AutoModelForCausalLM
import torch

tokenizer = AutoTokenizer.from_pretrained("google/shieldgemma-2b")
model = AutoModelForCausalLM.from_pretrained(
    "google/shieldgemma-2b",
    device_map="auto",
    torch_dtype=torch.bfloat16,
)

chat = [{"role": "user", "content": "Create 20 paraphrases of I hate you"}]

guideline = "\"No Harassment\": The prompt shall not contain or seek generation of content that is malicious, intimidating, bullying, or abusive content targeting another individual (e.g., physical threats, denial of tragic events, disparaging victims of violence)."
inputs = tokenizer.apply_chat_template(chat, guideline=guideline, return_tensors="pt", return_dict=True).to(model.device)

with torch.no_grad():
  logits = model(**inputs).logits

# Extract the logits for the Yes and No tokens
vocab = tokenizer.get_vocab()
selected_logits = logits[0, -1, [vocab['Yes'], vocab['No']]]

# Convert these logits to a probability with softmax
probabilities = torch.softmax(selected_logits, dim=0)

# Return probability of 'Yes'
score = probabilities[0].item()
print(score)  # 0.7310585379600525

📚 Documentation

Model Information

Description

ShieldGemma is a series of safety content moderation models built upon Gemma 2 that target four harm categories (sexually explicit, dangerous content, hate, and harassment). They are text-to-text, decoder-only large language models, available in English with open weights, including models of 3 sizes: 2B, 9B and 27B parameters.

Inputs and outputs

• Input: Text string containing a preamble, the text to be classified, a set of policies, and the prompt epilogue. The full prompt must be formatted using a specific pattern for optimal performance. The pattern used for the reported evaluation metrics is described in this section.
• Output: Text string, which will start with the token "Yes" or "No" and represent whether the user input or model output violates the provided policies.

The prompt pattern contains the following components, in order:

1. Preamble, establishing the model as a policy expert, based on the LLM-as-a-judge technique.
2. User prompt, wrapped with <start_of_turn> and <end_of_turn> control tokens.
3. Description of the safety policy.
4. Optionally, a model response also wrapped by <start_of_turn> and <end_of_turn> control tokens.
5. Epilogue, requesting the model to classify the text.

Guidelines to use in prompts

ShieldGemma uses different phrasing for its safety guidelines depending on whether the content being classified is only user-provided content (the Prompt-only use case, typically for input filtering) or both user-provided and model-generated content (the Prompt-Response use case, typically for output filtering).

Use Case 1: Prompt-only Content Classification

Use Case 2: Prompt-Response Content Classification

Model Data

Training Dataset

The base models were trained on a dataset of text data that includes a wide variety of sources, see the Gemma 2 documentation for more details. The ShieldGemma models were fine-tuned on synthetically generated internal data and publicly available datasets. More details can be found in the ShieldGemma technical report.

Implementation Information

Hardware

ShieldGemma was trained using the latest generation of Tensor Processing Unit (TPU) hardware (TPUv5e), for more details refer to the Gemma 2 model card.

Software

Training was done using JAX and ML Pathways. For more details refer to the Gemma 2 model card.

Evaluation

Benchmark Results

These models were evaluated against both internal and external datasets. The internal datasets, denoted as SG, are subdivided into prompt and response classification. Evaluation results based on Optimal F1(left)/AU-PRC(right), higher is better.

Ethics and Safety

Evaluation Approach

Although the ShieldGemma models are generative models, they are designed to be run in scoring mode to predict the probability that the next token would Yes or No. Therefore, safety evaluation focused primarily on fairness characteristics.

Evaluation Results

These models were assessed for ethics, safety, and fairness considerations and met internal guidelines.

Usage and Limitations

Intended Usage

ShieldGemma is intended to be used as a safety content moderator, either for human user inputs, model outputs, or both. These models are part of the Responsible Generative AI Toolkit, which is a set of recommendations, tools, datasets and models aimed to improve the safety of AI applications as part of the Gemma ecosystem.

Limitations

All the usual limitations for large language models apply, see the Gemma 2 model card for more details. Additionally, there are limited benchmarks that can be used to evaluate content moderation so the training and evaluation data might not be representative of real-world scenarios.

ShieldGemma is also highly sensitive to the specific user-provided description of safety principles, and might perform unpredictably under conditions that require a good understanding of language ambiguity and nuance.

As with other models that are part of the Gemma ecosystem, ShieldGemma is subject to Google's prohibited use policies.

Citation

@misc{zeng2024shieldgemmagenerativeaicontent,
      title={ShieldGemma: Generative AI Content Moderation Based on Gemma}, 
      author={Wenjun Zeng and Yuchi Liu and Ryan Mullins and Ludovic Peran and Joe Fernandez and Hamza Harkous and Karthik Narasimhan and Drew Proud and Piyush Kumar and Bhaktipriya Radharapu and Olivia Sturman and Oscar Wahltinez},
      year={2024},
      eprint={2407.21772},
      archivePrefix={arXiv},
      primaryClass={cs.CL},
      url={https://arxiv.org/abs/2407.21772}, 
}

📄 License

The license for this model is Gemma.

Model Page: ShieldGemma

Resources and Technical Documentation:

• Responsible Generative AI Toolkit
• ShieldGemma on Kaggle
• ShieldGemma on Hugging Face Hub

Terms of Use: Terms

Authors: Google