Hugging Face 的 LOGO

Transformers 文件

Cohere

Hugging Face's logo
加入 Hugging Face 社群

並獲得增強的文件體驗

開始使用

PyTorch FlashAttention SDPA

Cohere

Cohere Command-R 是一個擁有 350 億引數的多語言大型語言模型，專為長上下文任務設計，如檢索增強生成 (RAG) 和呼叫外部 API 及工具。該模型經過專門訓練，用於基於事實的生成，並支援單步和多步工具使用。它支援 128K 詞元（token）的上下文長度。

你可以在 Command 模型 合集中找到所有原始的 Command-R 檢查點。

點選右側邊欄中的 Cohere 模型，檢視更多關於如何將 Cohere 應用於不同語言任務的示例。

下面的示例演示瞭如何使用 Pipeline 或 AutoModel，以及如何從命令列生成文字。

流水線
自動模型
Transformers CLI
import torch
from transformers import pipeline

pipeline = pipeline(
    task="text-generation",
    model="CohereForAI/c4ai-command-r-v01",
    torch_dtype=torch.float16,
    device=0
)
pipeline("Plants create energy through a process known as")

量化透過以較低精度表示權重來減少大型模型的記憶體負擔。有關更多可用量化後端，請參閱量化概述。

以下示例使用 bitsandbytes 將權重量化為 4 位。

import torch
from transformers import BitsAndBytesConfig, AutoTokenizer, AutoModelForCausalLM

bnb_config = BitsAndBytesConfig(load_in_4bit=True)
tokenizer = AutoTokenizer.from_pretrained("CohereForAI/c4ai-command-r-v01")
model = AutoModelForCausalLM.from_pretrained("CohereForAI/c4ai-command-r-v01", torch_dtype=torch.float16, device_map="auto", quantization_config=bnb_config, attn_implementation="sdpa")

# format message with the Command-R chat template
messages = [{"role": "user", "content": "How do plants make energy?"}]
input_ids = tokenizer.apply_chat_template(messages, tokenize=True, add_generation_prompt=True, return_tensors="pt").to("cuda")
output = model.generate(
    input_ids,
    max_new_tokens=100,
    do_sample=True,
    temperature=0.3,
    cache_implementation="static",
)
print(tokenizer.decode(output[0], skip_special_tokens=True))

使用 AttentionMaskVisualizer 可以更好地理解模型能夠和不能夠關注哪些詞元（token）。

from transformers.utils.attention_visualizer import AttentionMaskVisualizer

visualizer = AttentionMaskVisualizer("CohereForAI/c4ai-command-r-v01")
visualizer("Plants create energy through a process known as")

注意事項

CohereConfig

class transformers.CohereConfig

< >

( vocab_size = 256000 hidden_size = 8192 intermediate_size = 22528 logit_scale = 0.0625 num_hidden_layers = 40 num_attention_heads = 64 num_key_value_heads = None hidden_act = 'silu' max_position_embeddings = 8192 initializer_range = 0.02 layer_norm_eps = 1e-05 use_cache = True pad_token_id = 0 bos_token_id = 5 eos_token_id = 255001 tie_word_embeddings = True rope_theta = 10000.0 rope_scaling = None attention_bias = False attention_dropout = 0.0 use_qk_norm = False **kwargs )

引數

  • vocab_size (int, 可選, 預設為 256000) — Cohere 模型的詞彙表大小。定義了在呼叫 CohereModel 時，`inputs_ids` 可以表示的不同詞元（token）的數量。
  • hidden_size (int, 可選, 預設為 8192) — 隱藏表示的維度。
  • intermediate_size (int, 可選, 預設為 22528) — MLP 表示的維度。
  • logit_scale (float, 可選, 預設為 0.0625) — 輸出 logits 的縮放因子。
  • num_hidden_layers (int, 可選, 預設為 40) — Transformer 解碼器中的隱藏層數量。
  • num_attention_heads (int, 可選, 預設為 64) — Transformer 解碼器中每個注意力層的注意力頭數量。
  • num_key_value_heads (int, 可選) — 這是用於實現分組查詢注意力（Grouped Query Attention）的鍵值頭數量。如果 `num_key_value_heads=num_attention_heads`，模型將使用多頭注意力（MHA）；如果 `num_key_value_heads=1`，模型將使用多查詢注意力（MQA）；否則，使用 GQA。當將一個多頭檢查點轉換為 GQA 檢查點時，每個分組的鍵和值頭應透過對該組內所有原始頭進行均值池化來構建。更多細節請查閱這篇論文。如果未指定，將預設為 `num_attention_heads`。
  • hidden_act (str 或 function, 可選, 預設為 "silu") — 解碼器中的非線性啟用函式（函式或字串）。
  • max_position_embeddings (int, 可選, 預設為 8192) — 此模型可能使用的最大序列長度。
  • initializer_range (float, 可選, 預設為 0.02) — 用於初始化所有權重矩陣的截斷正態初始化器的標準差。
  • layer_norm_eps (float, 可選, 預設為 1e-05) — 層歸一化使用的 epsilon 值。
  • use_cache (bool, 可選, 預設為 True) — 模型是否應返回最後一個鍵/值注意力（並非所有模型都使用）。僅當 `config.is_decoder=True` 時相關。
  • pad_token_id (int, 可選, 預設為 0) — 填充詞元（token）的 ID。
  • bos_token_id (int, 可選, 預設為 5) — 序列開始詞元（token）的 ID。
  • eos_token_id (int, 可選, 預設為 255001) — 序列結束詞元（token）的 ID。
  • tie_word_embeddings (bool, 可選, 預設為 True) — 是否繫結詞嵌入權重。
  • rope_theta (float, 可選, 預設為 10000.0) — RoPE 嵌入的基礎週期。
  • rope_scaling (Dict, 可選) — 包含 RoPE 嵌入縮放配置的字典。注意：如果你應用了新的 rope 型別並期望模型能在更長的 `max_position_embeddings` 上工作，我們建議你相應地更新此值。預期內容：`rope_type` (str)：使用的 RoPE 子變體。可以是 ['default', 'linear', 'dynamic', 'yarn', 'longrope', 'llama3'] 中的一個，其中 'default' 是原始的 RoPE 實現。`factor` (float, *可選*)：用於除 'default' 外的所有 rope 型別。應用於 RoPE 嵌入的縮放因子。在大多數縮放型別中，`factor` 為 x 將使模型能夠處理長度為 x * 原始最大預訓練長度的序列。`original_max_position_embeddings` (int, *可選*)：用於 'dynamic'、'longrope' 和 'llama3'。預訓練期間使用的原始最大位置嵌入。`attention_factor` (float, *可選*)：用於 'yarn' 和 'longrope'。應用於注意力計算的縮放因子。如果未指定，它將預設為實現推薦的值，使用 `factor` 欄位推斷建議值。`beta_fast` (float, *可選*)：僅用於 'yarn'。用於設定線性斜坡函式中外推邊界（僅限）的引數。如果未指定，預設為 32。`beta_slow` (float, *可選*)：僅用於 'yarn'。用於設定線性斜坡函式中內插邊界（僅限）的引數。如果未指定，預設為 1。`short_factor` (list[float], *可選*)：僅用於 'longrope'。應用於短上下文（< `original_max_position_embeddings`）的縮放因子。必須是一個數字列表，其長度與隱藏大小除以注意力頭數再除以 2 相同。`long_factor` (list[float], *可選*)：僅用於 'longrope'。應用於長上下文（< `original_max_position_embeddings`）的縮放因子。必須是一個數字列表，其長度與隱藏大小除以注意力頭數再除以 2 相同。`low_freq_factor` (float, *可選*)：僅用於 'llama3'。應用於 RoPE 低頻分量的縮放因子。`high_freq_factor` (float, *可選*)：僅用於 'llama3'。應用於 RoPE 高頻分量的縮放因子。
  • attention_bias (bool, 預設為 False, 可選, 預設為 False) — 在自注意力期間是否在查詢、鍵、值和輸出投影層中使用偏置。
  • attention_dropout (float, 可選, 預設為 0.0) — 注意力機率的 dropout 比率。
  • use_qk_norm (bool, 可選, 預設為 False) — 是否在注意力機制中使用查詢-鍵歸一化。

這是一個用於儲存 CohereModel 配置的配置類。它用於根據指定的引數例項化一個 Cohere 模型，定義模型架構。

配置物件繼承自 PretrainedConfig，可用於控制模型輸出。請閱讀 PretrainedConfig 的文件以獲取更多資訊。使用預設值例項化配置將產生與 CohereForAI/c4ai-command-r-v01 模型類似的配置。

>>> from transformers import CohereModel, CohereConfig

>>> # Initializing a Cohere model configuration
>>> configuration = CohereConfig()

>>> # Initializing a model from the Cohere configuration
>>> model = CohereModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.config

CohereTokenizerFast

class transformers.CohereTokenizerFast

< >

( vocab_file = None merges_file = None tokenizer_file = None clean_up_tokenization_spaces = False unk_token = '<UNK>' bos_token = '<BOS_TOKEN>' eos_token = '<|END_OF_TURN_TOKEN|>' add_bos_token = True add_eos_token = False use_default_system_prompt = False add_prefix_space = False **kwargs )

引數

  • vocab_file (str, 可選) — 詞彙表文件的路徑。
  • merges_file (str, 可選) — 合併檔案的路徑。
  • tokenizer_file (str, 可選) — tokenizers 檔案（通常副檔名為 .json），包含載入分詞器所需的一切。
  • clean_up_tokenization_spaces (bool, 可選, 預設為 False) — 是否在解碼後清理空格，清理操作包括移除可能產生的額外空格等。
  • unk_token (str 或 tokenizers.AddedToken, 可選, 預設為 "<UNK>") — 未知詞元。不在詞彙表中的詞元無法轉換為 ID，將被設定為此詞元。
  • bos_token (str 或 tokenizers.AddedToken, 可選, 預設為 "<BOS_TOKEN>") — 序列開始詞元，在預訓練期間使用。可用作序列分類器詞元。
  • eos_token (str 或 tokenizers.AddedToken, 可選, 預設為 "<|END_OF_TURN_TOKEN|>") — 序列結束詞元。
  • add_bos_token (bool, 可選, 預設為 True) — 是否在序列開始處新增一個 `bos_token`。
  • add_eos_token (bool, 可選, 預設為 False) — 是否在序列結束處新增一個 `eos_token`。
  • use_default_system_prompt (bool, 可選, 預設為 False) — 是否應使用 Cohere 分詞器的預設系統提示。
  • add_prefix_space (bool, 可選, 預設為 False) — 分詞器是否應自動新增字首空格。

構建一個 Cohere 分詞器。基於位元組級的位元組對編碼（Byte-Pair-Encoding）。

此分詞器特別使用了位元組回退（ByteFallback）和 NFC 規範化。

>>> from transformers import AutoTokenizer

>>> tokenizer = AutoTokenizer.from_pretrained("CohereForAI/c4ai-command-r-v01")
>>> tokenizer.encode("Hello this is a test")
[5, 28339, 2075, 1801, 1671, 3282]

如果你想更改 `bos_token` 或 `eos_token`，請確保在初始化模型時指定它們，或者呼叫 `tokenizer.update_post_processor()` 以確保後處理正確完成（否則編碼序列的第一個詞元和最後一個詞元的值將不正確）。更多詳情，請查閱 [post-processors] (https://huggingface.co/docs/tokenizers/api/post-processors) 文件。

您可以透過在例項化此分詞器時傳遞 add_prefix_space=True 來繞過此行為，但由於模型並非以此方式進行預訓練，這可能會導致效能下降。

當與 is_split_into_words=True 一起使用時，此分詞器需要以 add_prefix_space=True 進行例項化。

此分詞器繼承自 PreTrainedTokenizerFast，其中包含了大部分主要方法。使用者應參考此超類以獲取有關這些方法的更多資訊。

build_inputs_with_special_tokens

< >

( token_ids_0 token_ids_1 = None )

get_special_tokens_mask

< >

( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None already_has_special_tokens: bool = False ) → 一個範圍在 [0, 1] 內的整數列表

引數

  • token_ids_0 (list[int]) — 第一個序列的 ID 列表。
  • token_ids_1 (list[int], 可選) — 第二個序列的 ID 列表。
  • already_has_special_tokens (bool, 可選, 預設為 False) — 詞元列表是否已經為模型格式化了特殊詞元。

返回

一個範圍在 [0, 1] 的整數列表

特殊令牌為 1，序列令牌為 0。

從未新增特殊令牌的令牌列表中檢索序列 ID。使用分詞器 prepare_for_model 或 encode_plus 方法新增特殊令牌時會呼叫此方法。

create_token_type_ids_from_sequences

< >

( token_ids_0: list token_ids_1: typing.Optional[list[int]] = None ) → list[int]

引數

  • token_ids_0 (list[int]) — 第一個分詞後的序列。
  • token_ids_1 (list[int], 可選) — 第二個分詞後的序列。

返回

list[int]

標記型別 ID。

建立與傳入序列對應的標記型別 ID。什麼是標記型別 ID？

如果模型有特殊的構建方式，應在子類中重寫此方法。

update_post_processor

< >

( )

使用當前的 bos_token 和 eos_token 更新底層後處理器。

save_vocabulary

< >

( save_directory: str filename_prefix: typing.Optional[str] = None ) → Tuple(str)

引數

  • save_directory (str) — 儲存詞彙表的目錄。
  • filename_prefix (str, 可選) — 可選的字首，新增到儲存檔名的開頭。

返回

Tuple(str)

儲存的檔案路徑。

僅儲存分詞器的詞彙表（詞彙表 + 新增的詞元）。

此方法不會儲存分詞器的配置和特殊詞元對映。使用 `_save_pretrained()` 來儲存分詞器的完整狀態。

CohereModel

class transformers.CohereModel

< >

( config: CohereConfig )

引數

  • config (CohereConfig) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

裸 Cohere 模型，輸出原始的隱藏狀態，沒有任何特定的頭部。

此模型繼承自 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 **flash_attn_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__()。

    什麼是輸入 ID？

  • 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]`。

    什麼是位置 ID？

  • 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 (形狀為 `(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`），根據配置 (CohereConfig) 和輸入包含不同的元素。

  • 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 後的注意力權重，用於計算自注意力頭中的加權平均值。

CohereModel 的前向方法，覆蓋了 `__call__` 特殊方法。

雖然前向傳播的流程需要在此函式內定義，但之後應呼叫 `Module` 例項而不是此函式，因為前者會處理執行前後處理步驟，而後者會靜默忽略它們。

CohereForCausalLM

class transformers.CohereForCausalLM

< >

( config )

引數

  • config (CohereForCausalLM) — 包含模型所有引數的模型配置類。使用配置檔案初始化不會載入與模型相關的權重，只會載入配置。請檢視 from_pretrained() 方法來載入模型權重。

用於因果語言建模的 Cohere 模型。

此模型繼承自 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.Union[list[torch.FloatTensor], transformers.cache_utils.Cache, NoneType] = 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.cohere.modeling_cohere.KwargsForCausalLM] ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)

引數

  • input_ids (torch.LongTensor，形狀為 (batch_size, sequence_length)，可選) — 輸入序列在詞彙表中的標記（token）索引。預設情況下，填充（Padding）將被忽略。

    可以使用 AutoTokenizer 獲取索引。有關詳細資訊，請參閱 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

    什麼是輸入 ID？

  • 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]。

    什麼是位置 ID？

  • past_key_values (Union[list[torch.FloatTensor], ~cache_utils.Cache, NoneType]) — 預計算的隱藏狀態（自注意力塊和交叉注意力塊中的鍵和值），可用於加速序列解碼。這通常是當 use_cache=True 或 config.use_cache=True 時，模型在解碼的前一階段返回的 past_key_values。

    允許兩種格式：

    • 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 (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 時），根據配置（CohereConfig）和輸入包含不同的元素。

  • 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 後的注意力權重，用於計算自注意力頭中的加權平均值。

CohereForCausalLM 的 forward 方法覆蓋了 __call__ 特殊方法。

雖然前向傳播的流程需要在此函式內定義，但之後應呼叫 `Module` 例項而不是此函式，因為前者會處理執行前後處理步驟，而後者會靜默忽略它們。

示例

>> from transformers import AutoTokenizer, CohereForCausalLM

>> model = CohereForCausalLM.from_pretrained("CohereForAI/c4ai-command-r-v01")
>> tokenizer = AutoTokenizer.from_pretrained("CohereForAI/c4ai-command-r-v01")

>> prompt = "Hey, are you conscious? Can you talk to me?"
>> 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]
"Hey, are you conscious? Can you talk to me?\nI'm not conscious, but I can talk to you."
< > 在 GitHub 上更新

←CodeLlama Cohere2→
© . This site is unofficial and not affiliated with Hugging Face, Inc.