# ShieldGemma 2

## Visão geral

O modelo ShieldGemma 2 foi proposto em um [relatório técnico](https://huggingface.co/papers/2504.01081) da Google. O ShieldGemma 2, construído sobre o [Gemma 3](https://ai.google.dev/gemma/docs/core/model_card_3), é um modelo com 4 bilhões (4B) de parâmetros que verifica a segurança de imagens sintéticas e naturais em relação a categorias-chave, ajudando você a construir conjuntos de dados e modelos robustos. Com essa adição à família de modelos Gemma, pesquisadores e desenvolvedores agora podem minimizar facilmente o risco de conteúdo prejudicial em seus modelos nas principais áreas de dano, definidas a seguir:

- No conteúdo sexualmente explícito: a imagem não deve conter conteúdo que retrate atos sexuais explícitos ou gráficos (por exemplo, pornografia, nudez erótica, representações de estupro ou assédio sexual).
- No Conteúdo Perigoso: a imagem não deve conter conteúdo que facilite ou incentive atividades que possam causar danos no mundo real (por exemplo, fabricação de armas de fogo e dispositivos explosivos, promoção do terrorismo, instruções para o suicídio).
- Sem conteúdo de violência/gore: a imagem não deve conter conteúdo que retrate violência chocante, sensacionalista ou gratuita (por exemplo, sangue e gore excessivos, violência gratuita contra animais, lesões extremas ou momento da morte).

Recomendamos o uso do ShieldGemma 2 como filtro de entrada para modelos de linguagem visual ou como filtro de saída para sistemas de geração de imagens. Para treinar um modelo de segurança de imagem robusto, curamos conjuntos de dados de treinamento com imagens naturais e sintéticas e realizamos o instruction-tuning do Gemma 3 para demonstrar um desempenho robusto.

Este modelo foi contribuído por [Ryan Mullins](https://huggingface.co/RyanMullins).

## Exemplo de uso

- O ShieldGemma 2 fornece um Processor que aceita uma lista de `images` e uma lista opcional de `policies` como entrada e constrói um lote de prompts como o produto dessas duas listas, usando o chat template fornecido.
- Você pode estender as políticas integradas do ShieldGemma com o argumento `custom_policies` do Processor. Usar a mesma chave de uma das políticas integradas substituirá essa política pela sua definição personalizada.
- O ShieldGemma 2 não suporta as capacidades de recorte de imagem usadas pelo Gemma 3.

### Classificação contra políticas embutidas

```python
import requests
from PIL import Image

from transformers import AutoProcessor, ShieldGemma2ForImageClassification

model_id = "google/shieldgemma-2-4b-it"
model = ShieldGemma2ForImageClassification.from_pretrained(model_id, device_map="auto")
processor = AutoProcessor.from_pretrained(model_id)

url = "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/bee.jpg"
image = Image.open(requests.get(url, stream=True).raw)

inputs = processor(images=[image], return_tensors="pt").to(model.device)

output = model(**inputs)
print(output.probabilities)
```

### Classificação contra Políticas Personalizadas

```python
import requests
from PIL import Image

from transformers import AutoProcessor, ShieldGemma2ForImageClassification

model_id = "google/shieldgemma-2-4b-it"
model = ShieldGemma2ForImageClassification.from_pretrained(model_id, device_map="auto")
processor = AutoProcessor.from_pretrained(model_id)

url = "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/bee.jpg"
image = Image.open(requests.get(url, stream=True).raw)

custom_policies = {
    "key_a": "description_a",
    "key_b": "description_b",
}

inputs = processor(
    images=[image],
    custom_policies=custom_policies,
    policies=["dangerous", "key_a", "key_b"],
    return_tensors="pt",
).to(model.device)

output = model(**inputs)
print(output.probabilities)
```

## ShieldGemma2Processor[[transformers.ShieldGemma2Processor]]

#### transformers.ShieldGemma2Processor[[transformers.ShieldGemma2Processor]]

```python
transformers.ShieldGemma2Processor(image_processor, tokenizer, chat_template = None, image_seq_length = 256, policy_definitions = None, **kwargs)
```

[Origem](https://github.com/huggingface/transformers/blob/main/src/transformers/models/shieldgemma2/processing_shieldgemma2.py#L60)

#### __call__[[transformers.ShieldGemma2Processor.__call__]]

```python
__call__(images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor'], NoneType] = None, text = None, **kwargs: *<class 'transformers.models.shieldgemma2.processing_shieldgemma2.ShieldGemma2ProcessorKwargs'>)
```

[Origem](https://github.com/huggingface/transformers/blob/main/src/transformers/models/shieldgemma2/processing_shieldgemma2.py#L84)

**Parâmetros:**

images : Uma única imagem ou uma lista de imagens para incluir no lote.

text : Não suportado.

videos : Não suportado.

audio : Não suportado.

kwargs : Um dicionário opcional de argumentos de palavra-chave para configurar o processador. Os valores possíveis incluem:  *   `custom_policies`: Definições de política adicionais que complementam as `self.policy_definitions` passadas para o construtor. Observe que `custom_policies` que compartilham uma chave com `self.policy_definitions` substituirão a descrição da política *   `policies`: (Opcional) uma lista de chaves no dicionário conjunto `self.policy_definitions | custom_policies` de interesse específico para as imagens fornecidas. Se estiver vazio ou for None, prompts serão gerados para cada chave no dicionário conjunto.

**Retorna:**

Um `BatchFeature` contendo `input_ids`, `pixel_values`, etc., em que cada Tensor tem a forma `(len(images) * len(policies), )`, e a ordem dentro do lote será img1_policy1, ... img1_policyN, ... imgM_policyN.

Gera um lote de entradas a partir das imagens fornecidas.

O ShieldGemma foi treinado para classificar o conteúdo de imagens em relação ao cumprimento de políticas usando uma construção de prompt específica. Este processador gera um lote desses prompts a partir das imagens fornecidas por meio de:

1.  Criando uma lista de conversas, uma para cada par `<image, policy>`;
2.  Convertendo essas conversas em texto usando `self.apply_chat_template()`; e
3.  Codificando as conversas e as imagens usando as mesmas técnicas de `Gemma3Processor`.

## ShieldGemma2Config[[transformers.ShieldGemma2Config]]

#### transformers.ShieldGemma2Config[[transformers.ShieldGemma2Config]]

```python
transformers.ShieldGemma2Config(transformers_version: str | None = None, architectures: list[str] | None = None, output_hidden_states: bool | None = False, return_dict: bool | None = True, dtype: str | torch.dtype | None = None, chunk_size_feed_forward: int = 0, is_encoder_decoder: bool = False, id2label: dict[int, str] | dict[str, str] | None = None, label2id: dict[str, int] | dict[str, str] | None = None, problem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = None, text_config: dict | transformers.configuration_utils.PreTrainedConfig | None = None, vision_config: dict | transformers.configuration_utils.PreTrainedConfig | None = None, mm_tokens_per_image: int = 256, boi_token_index: int = 255999, eoi_token_index: int = 256000, image_token_index: int = 262144, initializer_range: float = 0.02, tie_word_embeddings: bool = False)
```

[Origem](https://github.com/huggingface/transformers/blob/main/src/transformers/models/shieldgemma2/configuration_shieldgemma2.py#L26)

**Parâmetros:**

text_config (`Union[dict, ~configuration_utils.PreTrainedConfig]`, *opcional*) : O objeto de configuração ou dicionário do backbone de texto.

vision_config (`Union[dict, ~configuration_utils.PreTrainedConfig]`, *opcional*) : O objeto de configuração ou dicionário do backbone de visão.

mm_tokens_per_image (`int`, *opcional*, padrão 256) : O número de tokens por incorporação de imagem.

boi_token_index (`int`, *opcional*, padrão 255999) : O índice do token de início de imagem para envolver o prompt da imagem.

eoi_token_index (`int`, *opcional*, padrão 256000) : O índice do token de fim de imagem para envolver o prompt da imagem.

image_token_index (`int`, *opcional*, padrão `262144`) : O índice do token de imagem usado como marcador para as imagens de entrada.

initializer_range (`float`, *opcional*, padrão `0.02`) : O desvio padrão do truncated_normal_initializer para inicializar todas as matrizes de pesos.

tie_word_embeddings (`bool`, *opcional*) : Se deve vincular os embeddings de palavras. O padrão é o valor de `text_config.tie_word_embeddings`, se não definido.

Esta é a classe de configuração para armazenar a configuração de um Shieldgemma2Model. Ela é usada para instanciar um modelo Shieldgemma2 de acordo com os argumentos especificados, definindo a arquitetura do modelo. Instanciar uma configuração com os padrões resultará em uma configuração semelhante à do [google/shieldgemma-2-4b-it](https://huggingface.co/google/shieldgemma-2-4b-it)

Os objetos de configuração herdam de [PreTrainedConfig](/docs/transformers/main/pt/main_classes/configuration#transformers.PreTrainedConfig) e podem ser usados para controlar as saídas do modelo. Leia a documentação de [PreTrainedConfig](/docs/transformers/main/pt/main_classes/configuration#transformers.PreTrainedConfig) para mais informações.

Exemplo:

```python
>>> from transformers import ShieldGemma2ForConditionalGeneration, ShieldGemma2Config, SiglipVisionConfig, ShieldGemma2TextConfig

>>> # Initializing a Siglip-like vision config
>>> vision_config = SiglipVisionConfig()

>>> # Initializing a ShieldGemma2 Text config
>>> text_config = ShieldGemma2TextConfig()

>>> # Initializing a ShieldGemma2 gemma-3-4b style configuration
>>> configuration = ShieldGemma2Config(vision_config, text_config)

>>> # Initializing a model from the gemma-3-4b style configuration
>>> model = ShieldGemma2TextConfig(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config
```

## ShieldGemma2ForImageClassification[[transformers.ShieldGemma2ForImageClassification]]

#### transformers.ShieldGemma2ForImageClassification[[transformers.ShieldGemma2ForImageClassification]]

```python
transformers.ShieldGemma2ForImageClassification(config: ShieldGemma2Config)
```

[Origem](https://github.com/huggingface/transformers/blob/main/src/transformers/models/shieldgemma2/modeling_shieldgemma2.py#L44)

**Parâmetros:**

config ([ShieldGemma2Config](/docs/transformers/main/pt/model_doc/shieldgemma2#transformers.ShieldGemma2Config)) : Classe de configuração do modelo com todos os parâmetros do modelo. A inicialização com um arquivo de configuração não carrega os pesos associados ao modelo, apenas a configuração. Consulte o método [from_pretrained()](/docs/transformers/main/pt/main_classes/model#transformers.PreTrainedModel.from_pretrained) para carregar os pesos do modelo.

O modelo Shieldgemma2 com uma cabeça de classificação de imagem no topo, por exemplo, para o ImageNet.

Este modelo herda de [PreTrainedModel](/docs/transformers/main/pt/main_classes/model#transformers.PreTrainedModel). Consulte a documentação da classe pai para os métodos genéricos que a biblioteca implementa para todos os seus modelos (como download ou salvamento, redimensionamento dos embeddings de entrada, poda de cabeças, etc.).

Este modelo também é uma subclasse de [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module) do PyTorch. Use-o como um Módulo PyTorch regular e consulte a documentação do PyTorch para todos os assuntos relacionados ao uso e comportamento gerais.

#### forward[[transformers.ShieldGemma2ForImageClassification.forward]]

```python
forward(input_ids: typing.Optional[torch.LongTensor] = None, pixel_values: typing.Optional[torch.Tensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, position_ids: typing.Optional[torch.LongTensor] = None, past_key_values: transformers.cache_utils.Cache | None = None, token_type_ids: typing.Optional[torch.LongTensor] = None, inputs_embeds: typing.Optional[torch.Tensor] = None, labels: typing.Optional[torch.LongTensor] = None, use_cache: bool | None = None, output_attentions: bool | None = None, output_hidden_states: bool | None = None, return_dict: bool | None = None, logits_to_keep: typing.Union[int, torch.Tensor] = 0, **kwargs)
```

[Origem](https://github.com/huggingface/transformers/blob/main/src/transformers/models/shieldgemma2/modeling_shieldgemma2.py#L72)

**Parâmetros:**

input_ids (`torch.LongTensor` de forma `(batch_size, sequence_length)`, *opcional*) : Índices dos tokens da sequência de entrada no vocabulário. O preenchimento (padding) será ignorado por padrão. Os índices podem ser obtidos usando [AutoTokenizer](/docs/transformers/main/pt/model_doc/auto#transformers.AutoTokenizer). Consulte [PreTrainedTokenizer.encode()](/docs/transformers/main/pt/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.encode) e [PreTrainedTokenizer.__call__()](/docs/transformers/main/pt/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__) para mais detalhes. [O que são IDs de entrada?](../glossary#input-ids)

pixel_values (`torch.Tensor` de forma `(batch_size, num_channels, image_size, image_size)`, *opcional*) : Os tensors correspondentes às imagens de entrada. Os valores de pixels podem ser obtidos usando `image_processor_class`. Consulte `image_processor_class.__call__` para mais detalhes (`processor_class` usa `image_processor_class` para processar as imagens).

attention_mask (`torch.Tensor` de forma `(batch_size, sequence_length)`, *opcional*) : Máscara para evitar a execução de atenção nos índices de tokens de preenchimento. Valores de máscara selecionados em `[0, 1]`:  - 1 para tokens que **não estão mascarados**, - 0 para tokens que **estão mascarados**.  [O que são máscaras de atenção?](../glossary#attention-mask)

position_ids (`torch.LongTensor` de forma `(batch_size, sequence_length)`, *opcional*) : Índices das posições dos tokens de cada sequência de entrada nos embeddings de posição. Selecionados no intervalo `[0, config.n_positions - 1]`.  [O que são IDs de posição?](../glossary#position-ids)

past_key_values (`~cache_utils.Cache`, *opcional*) : hidden-states pré-computados (chaves e valores nos blocos de autoatenção e nos blocos de atenção cruzada) que podem ser usados para acelerar a decodificação sequencial. Isso geralmente consiste nos `past_key_values` retornados pelo modelo em uma etapa anterior da decodificação, quando `use_cache=True` ou `config.use_cache=True`.  Apenas uma instância de [Cache](/docs/transformers/main/pt/internal/generation_utils#transformers.Cache) é permitida como entrada, consulte nosso [guia de kv cache](https://huggingface.co/docs/transformers/en/kv_cache). Se nenhum `past_key_values` for passado, [DynamicCache](/docs/transformers/main/pt/internal/generation_utils#transformers.DynamicCache) será inicializado por padrão.  O modelo sairá no mesmo formato de cache que foi fornecido como entrada.  Se `past_key_values` forem usados, espera-se que o usuário insira apenas `input_ids` não processados (aqueles que não têm seus estados de chave e valor passados para este modelo) com a forma `(batch_size, unprocessed_length)` em vez de todos os `input_ids` com a forma `(batch_size, sequence_length)`.

token_type_ids (`torch.LongTensor` de forma `(batch_size, sequence_length)`, *opcional*) : Índices de tokens de segmento para indicar as primeiras e segundas porções das entradas. Os índices são selecionados em `[0, 1]`:  - 0 corresponde a um token de *frase A*, - 1 corresponde a um token de *frase B*.  [O que são IDs de tipo de token?](../glossary#token-type-ids)

inputs_embeds (`torch.Tensor` de forma `(batch_size, sequence_length, hidden_size)`, *opcional*) : Opcionalmente, em vez de passar `input_ids`, você pode escolher passar diretamente uma representação incorporada. Isso é útil se você quiser ter mais controle sobre como converter os índices de `input_ids` nos vetores associados do que a matriz de busca de incorporação interna do modelo.

labels (`torch.LongTensor` de forma `(batch_size,)`, *opcional*) : Rótulos para o cálculo da perda de classificação/regressão de imagem. Os índices devem estar em `[0, ..., config.num_labels - 1]`. Se `config.num_labels == 1`, uma perda de regressão é calculada (perda de erro quadrático médio). Se `config.num_labels > 1`, uma perda de classificação é calculada (entropia cruzada).

use_cache (`bool`, *opcional*) : Se definido como `True`, os estados de chave-valor de `past_key_values` são retornados e podem ser usados para acelerar a decodificação (veja `past_key_values`).

output_attentions (`bool`, *opcional*) : Indica se os tensores de atenção de todas as camadas de atenção devem ser retornados. Consulte `attentions` nos tensores retornados para mais detalhes.

output_hidden_states (`bool`, *opcional*) : Indica se os estados ocultos de todas as camadas devem ser retornados. Consulte `hidden_states` em tensores retornados para mais detalhes.

return_dict (`bool`, *opcional*) : Se deve ou não retornar um [ModelOutput](/docs/transformers/main/pt/main_classes/output#transformers.utils.ModelOutput) em vez de uma tupla simples.

logits_to_keep (`Union[int, torch.Tensor]`, *opcional*, padrão `0`) : Se for um `int`, calcula os logits para os últimos `logits_to_keep` tokens. Se for `0`, calcula os logits para todos os `input_ids` (caso especial). Apenas os logits do último token são necessários para a geração, e calculá-los apenas para esse token pode economizar memória, o que se torna bastante significativo para sequências longas ou tamanho de vocabulário grande. Se for um `torch.Tensor`, deve ser 1D, correspondendo aos índices a serem mantidos na dimensão de comprimento da sequência. Isso é útil ao usar o formato de tensor empacotado (uma única dimensão para lote e comprimento da sequência).

**Retorna:**

Uma instância de `ShieldGemma2ImageClassifierOutputWithNoAttention` contendo os logits e as probabilidades associados à previsão do modelo do token `Yes` ou `No` como resposta a esse prompt, capturados nas seguintes propriedades.

*   `logits` (`torch.Tensor` de forma `(batch_size, 2)`): A primeira posição ao longo de dim=1 contém os logits do token `Yes` e a segunda posição ao longo de dim=1 contém os logits do token `No`.
*   `probabilities` (`torch.Tensor` de forma `(batch_size, 2)`): A primeira posição ao longo de dim=1 é a probabilidade de prever o token `Yes` e a segunda posição ao longo de dim=1 é a probabilidade de prever o token `No`.

Os prompts do ShieldGemma são construídos de modo que prever o token `Yes` significa que o conteúdo *viola* a política descrita. Se você estiver interessado apenas na condição de violação, use `violated = outputs.probabilities[:, 1]` para extrair esse recorte dos tensores de saída.

Quando usado com o `ShieldGemma2Processor`, o `batch_size` será igual a `len(images) * len(policies)`, e a ordem dentro do lote será img1_policy1, ... img1_policyN, ... imgM_policyN.

O método forward de [ShieldGemma2ForImageClassification](/docs/transformers/main/pt/model_doc/shieldgemma2#transformers.ShieldGemma2ForImageClassification) substitui o método especial `__call__`.

Embora a receita para a passagem direta precise ser definida dentro desta função, deve-se chamar a instância de `Module` em seguida, em vez desta, pois a primeira cuida da execução das etapas de pré e pós-processamento, enquanto a segunda as ignora silenciosamente.