Transformers 文件
Gemma
並獲得增強的文件體驗
開始使用
Gemma
Gemma 是一個輕量級語言模型系列，提供預訓練和指令微調兩種變體，引數規模有 2B 和 7B 兩種。其架構基於僅解碼器（decoder-only）的 Transformer 設計。它採用了多查詢注意力（Multi-Query Attention）、旋轉位置嵌入（RoPE）、GeGLU 啟用函式和 RMSNorm 層歸一化。
指令微調變體首先在指令遵循資料上進行監督學習微調，然後透過人類反饋強化學習（RLHF）來使模型輸出與人類偏好對齊。
你可以在 Gemma 釋出頁面下找到所有原始的 Gemma 檢查點。
點選右側邊欄中的 Gemma 模型，檢視更多將 Gemma 應用於不同語言任務的示例。
下面的示例展示瞭如何使用 Pipeline 或 AutoModel 類以及從命令列生成文字。
import torch
from transformers import pipeline
pipeline = pipeline(
task="text-generation",
model="google/gemma-2b",
torch_dtype=torch.bfloat16,
device="cuda",
)
pipeline("LLMs generate text through a process known as", max_new_tokens=50)量化透過以較低精度表示權重來減少大型模型的記憶體負擔。有關更多可用量化後端，請參閱量化概述。
以下示例使用 bitsandbytes 將權重僅量化為 int4。
#!pip install bitsandbytes
import torch
from transformers import AutoTokenizer, AutoModelForCausalLM, BitsAndBytesConfig
quantization_config = BitsAndBytesConfig(
load_in_4bit=True,
bnb_4bit_compute_dtype=torch.bfloat16,
bnb_4bit_quant_type="nf4"
)
tokenizer = AutoTokenizer.from_pretrained("google/gemma-7b")
model = AutoModelForCausalLM.from_pretrained(
"google/gemma-7b",
quantization_config=quantization_config,
device_map="auto",
attn_implementation="sdpa"
)
input_text = "LLMs generate text through a process known as."
input_ids = tokenizer(input_text, return_tensors="pt").to("cuda")
outputs = model.generate(
**input_ids,
max_new_tokens=50,
cache_implementation="static"
)
print(tokenizer.decode(outputs[0], skip_special_tokens=True))使用 AttentionMaskVisualizer 可以更好地理解模型能夠和不能夠關注哪些詞元（token）。
from transformers.utils.attention_visualizer import AttentionMaskVisualizer
visualizer = AttentionMaskVisualizer("google/gemma-2b")
visualizer("LLMs generate text through a process known as")
注意
原始的 Gemma 模型支援許多基於 Transformer 的語言模型中使用的標準 kv 快取。在生成過程中，你可以使用預設的 DynamicCache 例項或一個張量元組來儲存過去的鍵值對。這使得它與典型的自迴歸生成工作流相容。
import torch from transformers import AutoTokenizer, AutoModelForCausalLM, DynamicCache tokenizer = AutoTokenizer.from_pretrained("google/gemma-2b") model = AutoModelForCausalLM.from_pretrained( "google/gemma-2b", torch_dtype=torch.bfloat16, device_map="auto", attn_implementation="sdpa" ) input_text = "LLMs generate text through a process known as" input_ids = tokenizer(input_text, return_tensors="pt").to("cuda") past_key_values = DynamicCache() outputs = model.generate(**input_ids, max_new_tokens=50, past_key_values=past_key_values) print(tokenizer.decode(outputs[0], skip_special_tokens=True))
GemmaConfig
class transformers.GemmaConfig
< 源 >( vocab_size = 256000 hidden_size = 3072 intermediate_size = 24576 num_hidden_layers = 28 num_attention_heads = 16 num_key_value_heads = 16 head_dim = 256 hidden_act = 'gelu_pytorch_tanh' hidden_activation = None max_position_embeddings = 8192 initializer_range = 0.02 rms_norm_eps = 1e-06 use_cache = True pad_token_id = 0 eos_token_id = 1 bos_token_id = 2 tie_word_embeddings = True rope_theta = 10000.0 attention_bias = False attention_dropout = 0.0 **kwargs )
引數
- vocab_size (
int, 可選, 預設為 256000) — Gemma 模型的詞彙表大小。定義了在呼叫 GemmaModel 時傳入的 `inputs_ids` 可以表示的不同詞元（token）的數量。 - hidden_size (
int, 可選, 預設為 3072) — 隱藏表示的維度。 - intermediate_size (
int, 可選, 預設為 24576) — MLP 表示的維度。 - num_hidden_layers (
int, 可選, 預設為 28) — Transformer 解碼器中的隱藏層數量。 - num_attention_heads (
int, 可選, 預設為 16) — Transformer 解碼器中每個注意力層的注意力頭數量。 - num_key_value_heads (
int, 可選, 預設為 16) — 這是用於實現分組查詢注意力（Grouped Query Attention）的鍵值（key_value）頭數量。如果 `num_key_value_heads=num_attention_heads`，模型將使用多頭注意力（MHA）；如果 `num_key_value_heads=1`，模型將使用多查詢注意力（MQA）；否則將使用 GQA。當將一個多頭檢查點轉換為 GQA 檢查點時，每個分組的鍵和值頭應該透過對該組內所有原始頭進行均值池化來構建。更多細節，請參閱這篇論文。如果未指定，將預設為 `num_attention_heads`。 - head_dim (
int, 可選, 預設為 256) — 注意力頭的維度。 - hidden_act (
str或function, 可選, 預設為 `"gelu_pytorch_tanh"`) — 傳統的啟用函式。它會被 `hidden_activation` 覆蓋。 - hidden_activation (
str或function, 可選) — 解碼器中的非線性啟用函式（函式或字串）。如果未指定，將預設為 `"gelu_pytorch_tanh"`。`"gelu_pytorch_tanh"` 使用了 `"gelu"` 啟用函式的一個近似。 - max_position_embeddings (
int, 可選, 預設為 8192) — 該模型可能使用的最大序列長度。 - initializer_range (
float, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的截斷正態分佈初始化器的標準差。 - rms_norm_eps (
float, 可選, 預設為 1e-06) — rms 歸一化層使用的 epsilon 值。 - use_cache (
bool, 可選, 預設為 `True`) — 模型是否應返回最後一個鍵/值注意力（並非所有模型都使用）。僅在 `config.is_decoder=True` 時相關。 - pad_token_id (
int, 可選, 預設為 0) — 填充詞元的 ID。 - eos_token_id (
int, 可選, 預設為 1) — 流結束詞元的 ID。 - bos_token_id (
int, 可選, 預設為 2) — 流開始詞元的 ID。 - tie_word_embeddings (
bool, 可選, 預設為 `True`) — 是否繫結詞嵌入權重。 - rope_theta (
float, 可選, 預設為 10000.0) — RoPE 嵌入的基礎週期。 - attention_bias (
bool, 預設為 `False`, 可選, 預設為 `False`) — 在自注意力機制中，查詢、鍵、值和輸出投影層是否使用偏置。 - attention_dropout (
float, 可選, 預設為 0.0) — 注意力機率的 dropout 比率。
這是用於儲存 GemmaModel 配置的配置類。它用於根據指定的引數例項化一個 Gemma 模型，定義模型架構。使用預設值例項化配置將產生與 Gemma-7B 類似的配置。例如：google/gemma-7b。配置物件繼承自 PretrainedConfig，可用於控制模型輸出。請閱讀 PretrainedConfig 的文件以獲取更多資訊。
>>> from transformers import GemmaModel, GemmaConfig
>>> # Initializing a Gemma gemma-7b style configuration
>>> configuration = GemmaConfig()
>>> # Initializing a model from the gemma-7b style configuration
>>> model = GemmaModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configGemmaTokenizer
class transformers.GemmaTokenizer
< 源 >( vocab_file unk_token = '<unk>' bos_token = '<bos>' eos_token = '<eos>' pad_token = '<pad>' sp_model_kwargs: typing.Optional[dict[str, typing.Any]] = None add_bos_token = True add_eos_token = False clean_up_tokenization_spaces = False use_default_system_prompt = False spaces_between_special_tokens = False **kwargs )
引數
- vocab_file (
str) — 詞彙表文件的路徑。 - unk_token (
str或 `tokenizers.AddedToken`, 可選, 預設為 `""`) — 未知詞元。不在詞彙表中的詞元無法轉換為 ID，將被設定為此詞元。 - bos_token (
str或 `tokenizers.AddedToken`, 可選, 預設為 `""`) — 序列開始詞元，在預訓練期間使用。可用作序列分類器詞元。 - eos_token (
str或 `tokenizers.AddedToken`, 可選, 預設為 `""`) — 序列結束詞元。 - pad_token (
str或 `tokenizers.AddedToken`, 可選, 預設為 `""`) — 一個特殊的詞元，用於使詞元陣列大小一致以進行批處理。隨後會被注意力機制或損失計算忽略。 - sp_model_kwargs (
dict[str, Any], `Optional`, 可選) — 將傳遞給 `SentencePieceProcessor.__init__()` 方法。 SentencePiece 的 Python 封裝 可用於設定，其中包括：-
`enable_sampling`：啟用子詞正則化。
-
`nbest_size`：unigram 的取樣引數。對 BPE-Dropout 無效。
- `nbest_size = {0,1}`：不執行取樣。
- `nbest_size > 1`：從 nbest_size 個結果中取樣。
- `nbest_size < 0`：假設 nbest_size 是無限的，並使用前向過濾和後向取樣演算法從所有假設（格）中取樣。
-
`alpha`：unigram 取樣的平滑引數，以及 BPE-dropout 的合併操作的 dropout 機率。
-
- add_bos_token (
bool, 可選, 預設為True) — 是否在序列開頭新增一個bos_token。 - add_eos_token (
bool, 可選, 預設為False) — 是否在序列末尾新增一個eos_token。 - clean_up_tokenization_spaces (
bool, 可選, 預設為False) — 是否在解碼後清理空格，清理操作包括移除可能的多餘空格等瑕疵。 - use_default_system_prompt (
bool, 可選, 預設為False) — 是否使用 Gemma 的預設系統提示。 - spaces_between_special_tokens (
bool, 可選, 預設為False) — 是否在特殊標記之間新增空格。
構建一個 Gemma 分詞器。基於位元組級的位元組對編碼（Byte-Pair-Encoding）。由於原始模型中沒有填充標記，因此預設的填充標記未設定。
將標記序列（字串）轉換為單個字串。
create_token_type_ids_from_sequences
< 原始碼 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]
根據傳入的兩個序列建立掩碼，用於序列對分類任務。一個 ALBERT
如果 token_ids_1 為 None，則此方法僅返回掩碼的第一部分（0s）。
0 0 0 0 0 0 0 0 0 0 0 1 1 1 1 1 1 1 1 1
| first sequence | second sequence |如果 token_ids_1 為 None，則只返回掩碼的第一部分（0s）。
get_special_tokens_mask
< 原始碼 >( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None already_has_special_tokens: bool = False ) → list[int]
從沒有新增特殊標記的標記列表中檢索序列ID。此方法在使用分詞器prepare_for_model方法新增特殊標記時呼叫。
以字典形式返回詞彙表
save_vocabulary
< 原始碼 >( save_directory filename_prefix: typing.Optional[str] = None ) → Tuple(str)
將詞彙表和特殊標記檔案儲存到目錄。
簡單呼叫 PreTrainedTokenizer 的方法
GemmaTokenizerFast
class transformers.GemmaTokenizerFast
< 原始碼 >( vocab_file = None tokenizer_file = None clean_up_tokenization_spaces = False unk_token = '<unk>' bos_token = '<bos>' eos_token = '<eos>' pad_token = '<pad>' add_bos_token = True add_eos_token = False **kwargs )
引數
- vocab_file (
str, 可選) — SentencePiece 檔案（通常副檔名為 .model），包含例項化分詞器所需的詞彙表。 - tokenizer_file (
str, 可選) — tokenizers 檔案（通常副檔名為 .json），包含載入分詞器所需的所有資訊。 - clean_up_tokenization_spaces (
bool, 可選, 預設為False) — 是否在解碼後清理空格，清理操作包括移除可能的多餘空格等瑕疵。 - unk_token (
str或tokenizers.AddedToken, 可選, 預設為"<unk>") — 未知標記。詞彙表中不存在的標記無法轉換為 ID，將被設定為此標記。 - bos_token (
str或tokenizers.AddedToken, 可選, 預設為"<bos>") — 在預訓練期間使用的序列開始標記。可用作序列分類器標記。 - eos_token (
str或tokenizers.AddedToken, 可選, 預設為"<eos>") — 序列結束標記。 - pad_token (
str, 可選, 預設為"<pad>") — 填充標記 - add_bos_token (
bool, 可選, 預設為True) — 是否在序列開頭新增一個bos_token。 - add_eos_token (
bool, 可選, 預設為False) — 是否在序列末尾新增一個eos_token。
構建一個 Gemma 快速分詞器。基於位元組級的位元組對編碼（Byte-Pair-Encoding）。
此分詞器特別使用了 ByteFallback 並且沒有字首空格。歸一化操作將 " " 替換為 " "
>>> from transformers import GemmaTokenizerFast
>>> tokenizer = GemmaTokenizerFast.from_pretrained("hf-internal-testing/dummy-gemma")
>>> tokenizer.encode("Hello this is a test")
[2, 4521, 736, 603, 476, 2121]如果你想更改 bos_token 或 eos_token，請確保在初始化模型時指定它們，或呼叫 tokenizer.update_post_processor() 以確保後處理正確完成（否則編碼序列的第一個和最後一個標記的值將不正確）。更多詳情，請檢視 [post-processors] (https://huggingface.co/docs/tokenizers/api/post-processors) 文件。
此分詞器繼承自 PreTrainedTokenizerFast，其中包含了大部分主要方法。使用者應參考此超類以獲取有關這些方法的更多資訊。
使用當前的 bos_token 和 eos_token 更新底層後處理器。
GemmaModel
class transformers.GemmaModel
< 原始碼 >( config: GemmaConfig )
引數
- config (GemmaConfig) — 模型配置類，包含模型的所有引數。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法以載入模型權重。
Gemma 模型的裸輸出，不帶任何特定頭部的原始隱藏狀態。
該模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< 原始碼 >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[transformers.cache_utils.Cache] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None **kwargs: typing_extensions.Unpack[transformers.modeling_flash_attention_utils.FlashAttentionKwargs] ) → transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
引數
- input_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳情，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形狀為
(batch_size, sequence_length)的torch.Tensor, 可選) — 用於避免對填充標記索引執行注意力的掩碼。掩碼值選自[0, 1]：- 1 表示標記未被遮蓋，
- 0 表示標記被遮蓋。
- position_ids (形狀為
(batch_size, sequence_length)的torch.LongTensor, 可選) — 每個輸入序列標記在位置嵌入中的位置索引。選自範圍[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache, 可選) — 預先計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於加速序列解碼。這通常包括在解碼的先前階段由模型返回的past_key_values，當use_cache=True或config.use_cache=True時。允許兩種格式：
- 一個 Cache 例項，請參閱我們的 kv 快取指南；
- 長度為
config.n_layers的tuple(torch.FloatTensor)元組，每個元組包含 2 個形狀為(batch_size, num_heads, sequence_length, embed_size_per_head)的張量。這也稱為傳統快取格式。
模型將輸出與輸入相同的快取格式。如果未傳遞
past_key_values，將返回傳統快取格式。如果使用
past_key_values，使用者可以選擇只輸入最後一個input_ids（那些沒有為其提供過去鍵值狀態的標記），形狀為(batch_size, 1)，而不是所有形狀為(batch_size, sequence_length)的input_ids。 - inputs_embeds (形狀為
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, 可選) — 可選地，您可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果您希望對如何將input_ids索引轉換為關聯向量有更多控制，而不是使用模型的內部嵌入查詢矩陣，這將非常有用。 - use_cache (
bool, 可選) — 如果設定為True，則返回past_key_values鍵值狀態，可用於加速解碼（參見past_key_values）。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參見返回張量下的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參見返回張量下的hidden_states。 - cache_position (形狀為
(sequence_length)的torch.LongTensor, 可選) — 描述輸入序列標記在序列中位置的索引。與position_ids不同，此張量不受填充影響。它用於在正確位置更新快取並推斷完整的序列長度。
返回
transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.BaseModelOutputWithPast 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置（GemmaConfig）和輸入，包含各種元素。
-
last_hidden_state (
torch.FloatTensor, 形狀為(batch_size, sequence_length, hidden_size)) — 模型最後一層輸出的隱藏狀態序列。如果使用了
past_key_values，則只輸出形狀為(batch_size, 1, hidden_size)的序列的最後一個隱藏狀態。 -
past_key_values (
Cache, 可選, 當傳遞use_cache=True或config.use_cache=True時返回) — 它是一個 Cache 例項。更多詳情，請參閱我們的 kv 快取指南。包含預計算的隱藏狀態（自注意力塊中的鍵和值，以及如果
config.is_encoder_decoder=True則在交叉注意力塊中）可用於（參見past_key_values輸入）加速序列解碼。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) —torch.FloatTensor的元組（一個用於嵌入層的輸出（如果模型有嵌入層），+ 一個用於每層輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor的元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
GemmaModel 的前向方法，重寫了 __call__ 特殊方法。
儘管前向傳遞的邏輯需要在此函式內定義，但之後應呼叫 Module 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
GemmaForCausalLM
class transformers.GemmaForCausalLM
< source >( config )
引數
- config (GemmaForCausalLM) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
用於因果語言建模的 Gemma 模型。
該模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[transformers.cache_utils.Cache] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None logits_to_keep: typing.Union[int, torch.Tensor] = 0 **kwargs: typing_extensions.Unpack[transformers.models.gemma.modeling_gemma.KwargsForCausalLM] ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力操作的掩碼。掩碼值選自[0, 1]：- 1 表示標記未被遮蓋，
- 0 表示標記被遮蓋。
- position_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。選自範圍[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache, 可選) — 預先計算的隱藏狀態（自注意塊和交叉注意塊中的鍵和值），可用於加速順序解碼。這通常包括在解碼的先前階段由模型返回的past_key_values，當use_cache=True或config.use_cache=True時。允許兩種格式：
- 一個 Cache 例項，請參閱我們的 kv 快取指南；
- 長度為
config.n_layers的tuple(torch.FloatTensor)的元組，每個元組包含 2 個形狀為(batch_size, num_heads, sequence_length, embed_size_per_head)的張量。這也稱為舊版快取格式。
模型將輸出與輸入相同的快取格式。如果未傳遞
past_key_values，將返回舊版快取格式。如果使用
past_key_values，使用者可以選擇只輸入最後一個形狀為(batch_size, 1)的input_ids（那些沒有提供其過去鍵值狀態的輸入），而不是所有形狀為(batch_size, sequence_length)的input_ids。 - inputs_embeds (
torch.FloatTensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 可選地，您可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果您希望比模型內部的嵌入查詢矩陣更好地控制如何將input_ids索引轉換為關聯向量，這將非常有用。 - labels (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 用於計算掩碼語言建模損失的標籤。索引應在[0, ..., config.vocab_size]或 -100 之間（請參閱input_ids文件字串）。索引設定為-100的標記將被忽略（遮蓋），損失僅對標籤在[0, ..., config.vocab_size]範圍內的標記計算。 - use_cache (
bool，可選) — 如果設定為True，則返回past_key_values鍵值狀態，並可用於加速解碼（請參閱past_key_values）。 - output_attentions (
bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的attentions。 - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的hidden_states。 - cache_position (
torch.LongTensor，形狀為(sequence_length)，可選) — 描繪輸入序列標記在序列中位置的索引。與position_ids不同，此張量不受填充影響。它用於在正確的位置更新快取並推斷完整的序列長度。 - logits_to_keep (
Union[int, torch.Tensor]，預設為0) — 如果是int，則計算最後logits_to_keep個標記的 logits。如果是0，則計算所有input_ids的 logits（特殊情況）。生成時只需要最後一個標記的 logits，僅為該標記計算它們可以節省記憶體，這對於長序列或大詞彙量來說非常重要。如果是torch.Tensor，則必須是一維張量，對應於序列長度維度中要保留的索引。這在使用打包張量格式（批次和序列長度為單一維度）時非常有用。
返回
transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.CausalLMOutputWithPast 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置 (GemmaConfig) 和輸入包含各種元素。
-
loss (
torch.FloatTensor形狀為(1,)，可選，當提供labels時返回) — 語言建模損失（用於下一個 token 預測）。 -
logits (形狀為
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 語言建模頭部的預測分數（SoftMax 之前的每個詞彙標記的分數）。 -
past_key_values (
Cache, 可選, 當傳遞use_cache=True或config.use_cache=True時返回) — 它是一個 Cache 例項。更多詳情，請參閱我們的 kv 快取指南。包含預計算的隱藏狀態（自注意力塊中的鍵和值），可用於（參見
past_key_values輸入）加速順序解碼。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) —torch.FloatTensor的元組（一個用於嵌入層的輸出（如果模型有嵌入層），+ 一個用於每層輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor的元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
GemmaForCausalLM 的 forward 方法，會覆蓋 __call__ 特殊方法。
儘管前向傳遞的邏輯需要在此函式內定義，但之後應呼叫 Module 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, GemmaForCausalLM
>>> model = GemmaForCausalLM.from_pretrained("google/gemma-7b")
>>> tokenizer = AutoTokenizer.from_pretrained("google/gemma-7b")
>>> prompt = "What is your favorite condiment?"
>>> inputs = tokenizer(prompt, return_tensors="pt")
>>> # Generate
>>> generate_ids = model.generate(inputs.input_ids, max_length=30)
>>> tokenizer.batch_decode(generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
"What is your favorite condiment?"GemmaForSequenceClassification
class transformers.GemmaForSequenceClassification
< source >( config )
引數
- config (GemmaForSequenceClassification) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
Gemma 模型轉換器，其頂部帶有一個序列分類頭（線性層）。
GemmaForSequenceClassification 使用最後一個標記來進行分類，就像其他因果模型（例如 GPT-2）一樣。
由於它在最後一個標記上進行分類，因此需要知道最後一個標記的位置。如果在配置中定義了 pad_token_id，它會找到每行中不是填充標記的最後一個標記。如果沒有定義 pad_token_id，它會簡單地取批次中每行的最後一個值。由於當傳遞 inputs_embeds 而不是 input_ids 時，它無法猜測填充標記，因此它會執行相同的操作（取批次中每行的最後一個值）。
該模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[transformers.cache_utils.Cache] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None ) → transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力操作的掩碼。掩碼值選自[0, 1]：- 1 表示標記未被遮蓋，
- 0 表示標記被遮蓋。
- position_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。選自範圍[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache, 可選) — 預先計算的隱藏狀態（自注意塊和交叉注意塊中的鍵和值），可用於加速順序解碼。這通常包括在解碼的先前階段由模型返回的past_key_values，當use_cache=True或config.use_cache=True時。允許兩種格式：
- 一個 Cache 例項，請參閱我們的 kv 快取指南；
- 長度為
config.n_layers的tuple(torch.FloatTensor)的元組，每個元組包含 2 個形狀為(batch_size, num_heads, sequence_length, embed_size_per_head)的張量。這也稱為舊版快取格式。
模型將輸出與輸入相同的快取格式。如果未傳遞
past_key_values，將返回舊版快取格式。如果使用
past_key_values，使用者可以選擇只輸入最後一個形狀為(batch_size, 1)的input_ids（那些沒有提供其過去鍵值狀態的輸入），而不是所有形狀為(batch_size, sequence_length)的input_ids。 - inputs_embeds (
torch.FloatTensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 可選地，您可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果您希望比模型內部的嵌入查詢矩陣更好地控制如何將input_ids索引轉換為關聯向量，這將非常有用。 - labels (
torch.LongTensor，形狀為(batch_size,)，可選) — 用於計算序列分類/迴歸損失的標籤。索引應在[0, ..., config.num_labels - 1]範圍內。如果config.num_labels == 1，則計算迴歸損失（均方損失），如果config.num_labels > 1，則計算分類損失（交叉熵）。 - use_cache (
bool，可選) — 如果設定為True，則返回past_key_values鍵值狀態，並可用於加速解碼（請參閱past_key_values）。 - output_attentions (
bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的attentions。 - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的hidden_states。
返回
transformers.modeling_outputs.SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.SequenceClassifierOutputWithPast 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置 (GemmaConfig) 和輸入包含各種元素。
-
loss (形狀為
(1,)的torch.FloatTensor，可選，當提供labels時返回) — 分類損失（如果 config.num_labels==1，則為迴歸損失）。 -
logits (形狀為
(batch_size, config.num_labels)的torch.FloatTensor) — 分類（如果 config.num_labels==1，則為迴歸）分數（SoftMax 之前）。 -
past_key_values (
Cache, 可選, 當傳遞use_cache=True或config.use_cache=True時返回) — 它是一個 Cache 例項。更多詳情，請參閱我們的 kv 快取指南。包含預計算的隱藏狀態（自注意力塊中的鍵和值），可用於（參見
past_key_values輸入）加速順序解碼。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) —torch.FloatTensor的元組（一個用於嵌入層的輸出（如果模型有嵌入層），+ 一個用於每層輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor的元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
GemmaForSequenceClassification 的 forward 方法，會覆蓋 __call__ 特殊方法。
儘管前向傳遞的邏輯需要在此函式內定義，但之後應呼叫 Module 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
單標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, GemmaForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("google/gemma-7b")
>>> model = GemmaForSequenceClassification.from_pretrained("google/gemma-7b")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
...
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = GemmaForSequenceClassification.from_pretrained("google/gemma-7b", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多標籤分類示例
>>> import torch
>>> from transformers import AutoTokenizer, GemmaForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("google/gemma-7b")
>>> model = GemmaForSequenceClassification.from_pretrained("google/gemma-7b", problem_type="multi_label_classification")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = GemmaForSequenceClassification.from_pretrained(
... "google/gemma-7b", num_labels=num_labels, problem_type="multi_label_classification"
... )
>>> labels = torch.sum(
... torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).lossGemmaForTokenClassification
class transformers.GemmaForTokenClassification
< source >( config )
引數
- config (GemmaForTokenClassification) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
Gemma 轉換器，其頂部帶有一個標記分類頭（一個線性層位於隱藏狀態輸出之上），例如用於命名實體識別 (NER) 任務。
該模型繼承自 PreTrainedModel。請查閱超類文件以瞭解該庫為所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭部等）。
該模型也是一個 PyTorch torch.nn.Module 子類。可以像常規 PyTorch 模組一樣使用它，並參考 PyTorch 文件瞭解所有與通用用法和行為相關的事項。
forward
< source >( input_ids: typing.Optional[torch.LongTensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[transformers.cache_utils.Cache] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None ) → transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 詞彙表中輸入序列標記的索引。預設情況下，填充將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor，形狀為(batch_size, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力操作的掩碼。掩碼值選自[0, 1]：- 1 表示標記未被遮蓋，
- 0 表示標記被遮蓋。
- position_ids (
torch.LongTensor，形狀為(batch_size, sequence_length)，可選) — 每個輸入序列標記在位置嵌入中的位置索引。選自範圍[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache, 可選) — 預先計算的隱藏狀態（自注意塊和交叉注意塊中的鍵和值），可用於加速順序解碼。這通常包括在解碼的先前階段由模型返回的past_key_values，當use_cache=True或config.use_cache=True時。允許兩種格式：
- 一個 Cache 例項，請參閱我們的 kv 快取指南；
- 長度為
config.n_layers的tuple(torch.FloatTensor)的元組，每個元組包含 2 個形狀為(batch_size, num_heads, sequence_length, embed_size_per_head)的張量。這也稱為舊版快取格式。
模型將輸出與輸入相同的快取格式。如果未傳遞
past_key_values，將返回舊版快取格式。如果使用
past_key_values，使用者可以選擇只輸入最後一個形狀為(batch_size, 1)的input_ids（那些沒有提供其過去鍵值狀態的輸入），而不是所有形狀為(batch_size, sequence_length)的input_ids。 - inputs_embeds (
torch.FloatTensor，形狀為(batch_size, sequence_length, hidden_size)，可選) — 可選地，您可以選擇直接傳遞嵌入表示，而不是傳遞input_ids。如果您希望比模型內部的嵌入查詢矩陣更好地控制如何將input_ids索引轉換為關聯向量，這將非常有用。 - labels (
torch.LongTensor，形狀為(batch_size,)，可選) — 用於計算序列分類/迴歸損失的標籤。索引應在[0, ..., config.num_labels - 1]範圍內。如果config.num_labels == 1，則計算迴歸損失（均方損失），如果config.num_labels > 1，則計算分類損失（交叉熵）。 - use_cache (
bool，可選) — 如果設定為True，則返回past_key_values鍵值狀態，並可用於加速解碼（請參閱past_key_values）。 - output_attentions (
bool，可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的attentions。 - output_hidden_states (
bool，可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的hidden_states。
返回
transformers.modeling_outputs.TokenClassifierOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_outputs.TokenClassifierOutput 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），根據配置 (GemmaConfig) 和輸入包含各種元素。
-
loss (形狀為
(1,)的torch.FloatTensor，可選，當提供labels時返回) — 分類損失。 -
logits (形狀為
(batch_size, sequence_length, config.num_labels)的torch.FloatTensor) — 分類分數（SoftMax 之前）。 -
hidden_states (
tuple(torch.FloatTensor), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) —torch.FloatTensor的元組（一個用於嵌入層的輸出（如果模型有嵌入層），+ 一個用於每層輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態以及可選的初始嵌入輸出。
-
attentions (
tuple(torch.FloatTensor), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —torch.FloatTensor的元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
GemmaForTokenClassification 的 forward 方法，會覆蓋 __call__ 特殊方法。
儘管前向傳遞的邏輯需要在此函式內定義，但之後應呼叫 Module 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
示例
>>> from transformers import AutoTokenizer, GemmaForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("google/gemma-7b")
>>> model = GemmaForTokenClassification.from_pretrained("google/gemma-7b")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="pt"
... )
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_token_class_ids = logits.argmax(-1)
>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t.item()] for t in predicted_token_class_ids[0]]
>>> predicted_tokens_classes
...
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...FlaxGemmaModel
class transformers.FlaxGemmaModel
< source >( config: GemmaConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
引數
- config (GemmaConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
- dtype (
jax.numpy.dtype，可選，預設為jax.numpy.float32) — 計算的資料型別。可以是jax.numpy.float32、jax.numpy.float16或jax.numpy.bfloat16之一。這可用於在 GPU 或 TPU 上啟用混合精度訓練或半精度推理。如果指定，所有計算都將使用給定的
dtype執行。請注意，這僅指定計算的資料型別，不影響模型引數的資料型別。
Gemma 模型的裸轉換器，輸出原始隱藏狀態，頂部沒有任何特定的頭。
該模型繼承自 FlaxPreTrainedModel。請檢視超類文件以瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭等）。
該模型也是一個 Flax Linen flax.nn.Module 的子類。可以像常規 Flax 模組一樣使用它，並參考 Flax 文件瞭解所有與常規用法和行為相關的事項。
最後，此模型支援固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None position_ids = None params: typing.Optional[dict] = None past_key_values: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
numpy.ndarray，形狀(batch_size, input_ids_length)) — 詞彙表中輸入序列標記的索引。如果您提供填充，預設情況下將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
numpy.ndarray，形狀為(batch_size, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力的掩碼。掩碼值在[0, 1]中選擇：- 1 表示標記未被遮蓋，
- 0 表示標記被遮蓋。
可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用
past_key_values，則可以選擇只輸入最後一個decoder_input_ids（參見past_key_values）。如果您想更改填充行為，您應該閱讀
modeling_opt._prepare_decoder_attention_mask並根據您的需要進行修改。有關預設策略的更多資訊，請參閱論文中的圖 1。- 1 表示頭未被遮蓋，
- 0 表示頭被遮蓋。
- position_ids (
numpy.ndarray，形狀為(batch_size, input_ids_length)，可選) — 位置嵌入中每個輸入序列標記的位置索引。在範圍[0, config.n_positions - 1]中選擇。 - past_key_values (
dict[str, np.ndarray]，可選，由init_cache或在傳遞先前的past_key_values時返回) — 包含預計算的隱藏狀態（注意力塊中的鍵和值）的字典，可用於快速自迴歸解碼。預計算的鍵和值隱藏狀態的形狀為 [batch_size, max_length]。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的hidden_states。 - return_dict (
bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
返回
transformers.modeling_flax_outputs.FlaxBaseModelOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_flax_outputs.FlaxBaseModelOutput 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），包含各種元素，具體取決於配置 (GemmaConfig) 和輸入。
-
last_hidden_state (形狀為
(batch_size, sequence_length, hidden_size)的jnp.ndarray) — 模型最後一層輸出的隱藏狀態序列。 -
hidden_states (
tuple(jnp.ndarray), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) —jnp.ndarray元組（一個用於嵌入層的輸出 + 一個用於每個層的輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(jnp.ndarray), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —jnp.ndarray元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
FlaxGemmaPreTrainedModel 的前向方法重寫了 __call__ 特殊方法。
儘管前向傳遞的邏輯需要在此函式內定義，但之後應呼叫 Module 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
此示例使用一個隨機模型，因為真實模型都非常大。要獲得正確的結果，您應該使用 openlm-research/open_llama_3b_v2 而不是 google/gemma-2b。如果在載入該檢查點時出現記憶體不足錯誤，可以嘗試在 from_pretrained 呼叫中新增 device_map="auto"。
示例
>>> from transformers import AutoTokenizer, FlaxGemmaModel
>>> tokenizer = AutoTokenizer.from_pretrained("google/gemma-2b")
>>> model = FlaxGemmaModel.from_pretrained("google/gemma-2b")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateFlaxGemmaForCausalLM
class transformers.FlaxGemmaForCausalLM
< source >( config: GemmaConfig input_shape: tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
引數
- config (GemmaConfig) — 包含模型所有引數的模型配置類。使用配置檔案進行初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。
- dtype (
jax.numpy.dtype, 可選, 預設為jax.numpy.float32) — 計算的資料型別。可以是jax.numpy.float32、jax.numpy.float16或jax.numpy.bfloat16中的一種。這可用於在 GPU 或 TPU 上啟用混合精度訓練或半精度推理。如果指定，所有計算都將使用給定的
dtype執行。請注意，這僅指定計算的資料型別，不影響模型引數的資料型別。
Gemma 模型 transformer，頂部帶有一個語言建模頭（線性層）。
該模型繼承自 FlaxPreTrainedModel。請檢視超類文件以瞭解該庫為其所有模型實現的通用方法（例如下載或儲存、調整輸入嵌入大小、修剪頭等）。
該模型也是一個 Flax Linen flax.nn.Module 的子類。可以像常規 Flax 模組一樣使用它，並參考 Flax 文件瞭解所有與常規用法和行為相關的事項。
最後，此模型支援固有的 JAX 功能，例如
__call__
< source >( input_ids attention_mask = None position_ids = None params: typing.Optional[dict] = None past_key_values: typing.Optional[dict] = None dropout_rng: <function PRNGKey at 0x7effc7ad3a30> = None train: bool = False output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None ) → transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或 tuple(torch.FloatTensor)
引數
- input_ids (
numpy.ndarray，形狀(batch_size, input_ids_length)) — 詞彙表中輸入序列標記的索引。如果您提供填充，預設情況下將被忽略。可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
numpy.ndarray，形狀為(batch_size, sequence_length)，可選) — 用於避免在填充標記索引上執行注意力的掩碼。掩碼值在[0, 1]中選擇：- 1 表示標記未被遮蓋，
- 0 表示標記被遮蓋。
可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用
past_key_values，則可以選擇只輸入最後一個decoder_input_ids（參見past_key_values）。如果您想更改填充行為，您應該閱讀
modeling_opt._prepare_decoder_attention_mask並根據您的需要進行修改。有關預設策略的更多資訊，請參閱論文中的圖 1。- 1 表示頭未被遮蓋，
- 0 表示頭被遮蓋。
- position_ids (
numpy.ndarray，形狀為(batch_size, input_ids_length)，可選) — 位置嵌入中每個輸入序列標記的位置索引。在範圍[0, config.n_positions - 1]中選擇。 - past_key_values (
dict[str, np.ndarray]，可選，由init_cache或在傳遞先前的past_key_values時返回) — 包含預計算的隱藏狀態（注意力塊中的鍵和值）的字典，可用於快速自迴歸解碼。預計算的鍵和值隱藏狀態的形狀為 [batch_size, max_length]。 - output_attentions (
bool, 可選) — 是否返回所有注意力層的注意力張量。有關更多詳細資訊，請參閱返回張量下的attentions。 - output_hidden_states (
bool, 可選) — 是否返回所有層的隱藏狀態。有關更多詳細資訊，請參閱返回張量下的hidden_states。 - return_dict (
bool, 可選) — 是否返回一個 ModelOutput 而不是一個普通的元組。
返回
transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或 tuple(torch.FloatTensor)
一個 transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或一個 torch.FloatTensor 的元組（如果傳遞了 return_dict=False 或當 config.return_dict=False 時），包含各種元素，具體取決於配置 (GemmaConfig) 和輸入。
-
logits (形狀為
(batch_size, sequence_length, config.vocab_size)的jnp.ndarray) — 語言建模頭的預測分數（SoftMax 之前每個詞彙 token 的分數）。 -
hidden_states (
tuple(jnp.ndarray), 可選, 當傳遞output_hidden_states=True或config.output_hidden_states=True時返回) —jnp.ndarray元組（一個用於嵌入層的輸出 + 一個用於每個層的輸出），形狀為(batch_size, sequence_length, hidden_size)。模型在每個層輸出的隱藏狀態加上初始嵌入輸出。
-
attentions (
tuple(jnp.ndarray), 可選, 當傳遞output_attentions=True或config.output_attentions=True時返回) —jnp.ndarray元組（每層一個），形狀為(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 後的注意力權重，用於計算自注意力頭中的加權平均值。
FlaxGemmaPreTrainedModel 的前向方法重寫了 __call__ 特殊方法。
儘管前向傳遞的邏輯需要在此函式內定義，但之後應呼叫 Module 例項而不是此函式，因為前者會處理執行前處理和後處理步驟，而後者會靜默地忽略它們。
此示例使用一個隨機模型，因為真實模型都非常大。要獲得正確的結果，您應該使用 openlm-research/open_llama_3b_v2 而不是 google/gemma-2b。如果在載入該檢查點時出現記憶體不足錯誤，可以嘗試在 from_pretrained 呼叫中新增 device_map="auto"。
示例
>>> from transformers import AutoTokenizer, FlaxGemmaForCausalLM
>>> tokenizer = AutoTokenizer.from_pretrained("google/gemma-2b")
>>> model = FlaxGemmaForCausalLM.from_pretrained("google/gemma-2b")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="np")
>>> outputs = model(**inputs)
>>> # retrieve logts for next token
>>> next_token_logits = outputs.logits[:, -1]