Transformers 文档
Cohere
并获得增强的文档体验
开始
Cohere
概述
Cohere Command-R 模型在博客文章 Command-R: Retrieval Augmented Generation at Production Scale 中由 Cohere 团队提出。
该论文的摘要如下
Command-R 是一个可扩展的生成模型，旨在用于 RAG 和工具使用，以实现面向企业生产规模的 AI。今天，我们推出 Command-R，这是一种新的 LLM，旨在用于大规模生产工作负载。Command-R 针对新兴的“可扩展”模型类别，这些模型在高效率和高精度之间取得平衡，使公司能够超越概念验证阶段，进入生产阶段。
*Command-R 是一个生成模型，针对长上下文任务进行了优化，例如检索增强生成 (RAG) 以及使用外部 API 和工具。它旨在与我们行业领先的 Embed 和 Rerank 模型协同工作，为 RAG 应用程序提供一流的集成，并在企业用例中表现出色。作为一个为公司规模化实施而构建的模型，Command-R 拥有
- RAG 和工具使用方面的强大准确性
- 低延迟和高吞吐量
- 更长的 128k 上下文和更低的定价
- 在 10 种主要语言中的强大能力
- 模型权重可在 HuggingFace 上用于研究和评估
在此处查看模型检查点 here。此模型由 Saurabh Dash 和 Ahmet Üstün 贡献。Hugging Face 中实现的代碼基于 GPT-NeoX here。
使用技巧
Hub 上上传的检查点使用 torch_dtype = 'float16'，AutoModel API 将使用它将检查点从 torch.float32 转换为 torch.float16。
在线权重的 dtype 大多无关紧要，除非您在使用 model = AutoModelForCausalLM.from_pretrained("path", torch_dtype = "auto") 初始化模型时使用 torch_dtype="auto"。原因是模型将首先被下载（使用在线检查点的 dtype），然后它将被转换为 torch 的默认 dtype（变为 torch.float32），最后，如果在配置中提供了 torch_dtype，则将使用它。
不建议在 float16 中训练模型，并且已知会产生 nan；因此，模型应在 bfloat16 中训练。
# pip install transformers
from transformers import AutoTokenizer, AutoModelForCausalLM
model_id = "CohereForAI/c4ai-command-r-v01"
tokenizer = AutoTokenizer.from_pretrained(model_id)
model = AutoModelForCausalLM.from_pretrained(model_id)
# Format message with the command-r chat template
messages = [{"role": "user", "content": "Hello, how are you?"}]
input_ids = tokenizer.apply_chat_template(messages, tokenize=True, add_generation_prompt=True, return_tensors="pt")
## <BOS_TOKEN><|START_OF_TURN_TOKEN|><|USER_TOKEN|>Hello, how are you?<|END_OF_TURN_TOKEN|><|START_OF_TURN_TOKEN|><|CHATBOT_TOKEN|>
gen_tokens = model.generate(
input_ids,
max_new_tokens=100,
do_sample=True,
temperature=0.3,
)
gen_text = tokenizer.decode(gen_tokens[0])
print(gen_text)- 当通过
attn_implementation="flash_attention_2"使用 Flash Attention 2 时，不要将torch_dtype传递给from_pretrained类方法，并使用自动混合精度训练。当使用Trainer时，只需将fp16或bf16指定为True即可。否则，请确保您正在使用torch.autocast。这是必需的，因为 Flash Attention 仅支持fp16和bf16数据类型。
资源
以下是官方 Hugging Face 和社区（以 🌎 符号表示）资源的列表，可帮助您开始使用 Command-R。如果您有兴趣提交资源以包含在此处，请随时打开 Pull Request，我们将进行审核！该资源最好展示一些新的东西，而不是重复现有的资源。
加载 FP16 模型
# pip install transformers
from transformers import AutoTokenizer, AutoModelForCausalLM
model_id = "CohereForAI/c4ai-command-r-v01"
tokenizer = AutoTokenizer.from_pretrained(model_id)
model = AutoModelForCausalLM.from_pretrained(model_id)
# Format message with the command-r chat template
messages = [{"role": "user", "content": "Hello, how are you?"}]
input_ids = tokenizer.apply_chat_template(messages, tokenize=True, add_generation_prompt=True, return_tensors="pt")
## <BOS_TOKEN><|START_OF_TURN_TOKEN|><|USER_TOKEN|>Hello, how are you?<|END_OF_TURN_TOKEN|><|START_OF_TURN_TOKEN|><|CHATBOT_TOKEN|>
gen_tokens = model.generate(
input_ids,
max_new_tokens=100,
do_sample=True,
temperature=0.3,
)
gen_text = tokenizer.decode(gen_tokens[0])
print(gen_text)加载 bitsnbytes 4bit 量化模型
# pip install transformers bitsandbytes accelerate
from transformers import AutoTokenizer, AutoModelForCausalLM, BitsAndBytesConfig
bnb_config = BitsAndBytesConfig(load_in_4bit=True)
model_id = "CohereForAI/c4ai-command-r-v01"
tokenizer = AutoTokenizer.from_pretrained(model_id)
model = AutoModelForCausalLM.from_pretrained(model_id, quantization_config=bnb_config)
gen_tokens = model.generate(
input_ids,
max_new_tokens=100,
do_sample=True,
temperature=0.3,
)
gen_text = tokenizer.decode(gen_tokens[0])
print(gen_text)CohereConfig
class transformers.CohereConfig
< source >( 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 的 key_value 头的数量。如果num_key_value_heads=num_attention_heads，模型将使用 Multi Head Attention (MHA)；如果num_key_value_heads=1，模型将使用 Multi Query Attention (MQA)；否则，将使用 GQA。当将多头检查点转换为 GQA 检查点时，每个组的 key 和 value 头应通过对该组内所有原始头进行均值池化来构建。有关更多详细信息，请查看 本文。如果未指定，则默认为num_attention_heads。 - hidden_act (
str或function, 可选, 默认为"silu") — 解码器中的非线性激活函数（函数或字符串）。 - max_position_embeddings (
int, 可选, 默认为 8192) — 此模型可能使用的最大序列长度。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, 可选, 默认为 1e-05) — 层归一化使用的 epsilon 值。 - use_cache (
bool, 可选, 默认为True) — 模型是否应返回最后的 key/values 注意力（并非所有模型都使用）。仅当config.is_decoder=True时相关。 - pad_token_id (
int, 可选, 默认为 0) — Padding token id。 - bos_token_id (
int, 可选, 默认为 5) — Beginning of stream token id。 - eos_token_id (
int, 可选, 默认为 255001) — End of stream token id。 - tie_word_embeddings (
bool, 可选, 默认为True) — 是否绑定权重 embedding - rope_theta (
float, 可选, 默认为 10000.0) — RoPE embeddings 的基期。 - 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 嵌入的缩放因子。在大多数缩放类型中，因子 x 将使模型能够处理长度为 x * 原始最大预训练长度的序列。original_max_position_embeddings(int, 可选)：与 ‘dynamic’、‘longrope’ 和 ‘llama3’ 一起使用。预训练期间使用的原始最大位置嵌入。attention_factor(float, 可选)：与 ‘yarn’ 和 ‘longrope’ 一起使用。应用于注意力计算的缩放因子。如果未指定，则默认为实现建议的值，使用factor字段推断建议值。beta_fast(float, 可选)：仅与 ‘yarn’ 一起使用。用于设置线性 ramp 函数中外推（仅限）边界的参数。如果未指定，则默认为 32。beta_slow(float, 可选)：仅与 ‘yarn’ 一起使用。用于设置线性 ramp 函数中内插（仅限）边界的参数。如果未指定，则默认为 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) — 是否在自注意力期间在 query, key, value 和 output 投影层中使用偏置。 - attention_dropout (
float, 可选, 默认为 0.0) — 注意力概率的 dropout 比率。 - use_qk_norm (
bool, 可选, 默认为False) — 是否在注意力机制中使用 query-key 归一化。
这是用于存储 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.configCohereTokenizerFast
class transformers.CohereTokenizerFast
< source >( 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, 可选) — merges 文件的路径。 - tokenizer_file (
str, 可选) — tokenizers 文件（通常具有 .json 扩展名），其中包含加载 tokenizer 所需的一切。 - clean_up_tokenization_spaces (
bool, 可选, 默认为False) — 是否清理解码后的空格，清理包括删除潜在的伪影，如额外的空格。 - unk_token (
str或tokenizers.AddedToken, 可选, 默认为"<UNK>") — 未知 token。 词汇表中不存在的 token 无法转换为 ID，而是设置为此 token。 - bos_token (
str或tokenizers.AddedToken, 可选, 默认为"<BOS_TOKEN>") — 预训练期间使用的序列开始 token。 可用作序列分类器 token。 - eos_token (
str或tokenizers.AddedToken, 可选, 默认为"<|END_OF_TURN_TOKEN|>") — 序列结束 token。 - add_bos_token (
bool, 可选, 默认为True) — 是否在序列的开头添加bos_token。 - add_eos_token (
bool, 可选, 默认为False) — 是否在序列的末尾添加eos_token。 - use_default_system_prompt (
bool, 可选, 默认为False) — 是否应使用 Cohere tokenizer 的默认系统提示。 - add_prefix_space (
bool, 可选, 默认为False) — tokenizer 是否应自动添加前缀空格。
构建 Cohere tokenizer。 基于字节级 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() 以确保正确完成后处理（否则，编码序列的第一个 token 和最后一个 token 的值将不正确）。 有关更多详细信息，请查看 [post-processors] (https://huggingface.co/docs/tokenizers/api/post-processors) 文档。
您可以通过在实例化此 tokenizer 时传递 add_prefix_space=True 来解决此行为，但由于模型并非以这种方式预训练，因此可能会导致性能下降。
当与 is_split_into_words=True 一起使用时，此 tokenizer 需要使用 add_prefix_space=True 进行实例化。
此 tokenizer 继承自 PreTrainedTokenizerFast，其中包含大多数主要方法。 用户应参考此超类以获取有关这些方法的更多信息。
get_special_tokens_mask
< source >( token_ids_0: typing.List[int] token_ids_1: typing.Optional[typing.List[int]] = None already_has_special_tokens: bool = False ) → 整数列表，范围为 [0, 1]
从没有添加特殊 token 的 token 列表中检索序列 ID。 当使用 tokenizer prepare_for_model 或 encode_plus 方法添加特殊 token 时，将调用此方法。
create_token_type_ids_from_sequences
< source >( token_ids_0: typing.List[int] token_ids_1: typing.Optional[typing.List[int]] = None ) → List[int]
创建与传递的序列对应的 token type IDs。 什么是 token type IDs？
如果模型有构建这些 token type IDs 的特殊方法，则应在子类中重写此方法。
使用当前的 bos_token 和 eos_token 更新底层的后处理器。
save_vocabulary
< source >( save_directory: str filename_prefix: typing.Optional[str] = None ) → Tuple(str)
仅保存 tokenizer 的词汇表（词汇表 + 添加的 token）。
此方法不会保存 tokenizer 的配置和特殊 token 映射。 使用 _save_pretrained() 保存 tokenizer 的整个状态。
CohereModel
class transformers.CohereModel
< source >( config: CohereConfig )
参数
- config (CohereConfig) — 带有模型所有参数的模型配置类。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。 查看 from_pretrained() 方法以加载模型权重。
- config — CohereConfig
裸 Cohere 模型，输出原始的隐藏状态，顶部没有任何特定的头部。 此模型继承自 PreTrainedModel。 查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是 PyTorch torch.nn.Module 的子类。 将其用作常规 PyTorch Module，并参阅 PyTorch 文档，了解与常规用法和行为相关的所有事项。
Transformer 解码器，由 config.num_hidden_layers 层组成。 每层都是一个 CohereDecoderLayer
forward
< source >( input_ids: 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 return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None **flash_attn_kwargs: typing_extensions.Unpack[transformers.modeling_flash_attention_utils.FlashAttentionKwargs] )
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor) — 词汇表中输入序列 token 的索引。 如果您提供填充，默认情况下将忽略填充。索引可以使用 AutoTokenizer 获得。 请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 了解详情。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor, optional) — 用于避免对填充 token 索引执行 attention 的掩码。 掩码值在[0, 1]中选择:- 1 表示 token 未被掩盖,
- 0 表示 token 被掩盖。
索引可以使用 AutoTokenizer 获得。 请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 了解详情。
如果使用
past_key_values，则可以选择仅输入最后一个input_ids（请参阅past_key_values）。如果您想更改填充行为，您应该阅读
modeling_opt._prepare_decoder_attention_mask并根据您的需要进行修改。 有关默认策略的更多信息，请参阅 论文 中的图 1。- 1 表示 head 未被掩盖,
- 0 表示 head 被掩盖。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor, optional) — 每个输入序列 token 在位置嵌入中的位置索引。 在[0, config.n_positions - 1]范围内选择。 - past_key_values (
Cache或tuple(tuple(torch.FloatTensor)), optional) — 预先计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），可用于加速顺序解码。 这通常包括模型在先前解码阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为
config.n_layers的tuple(tuple(torch.FloatTensor))，每个 tuple 都有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。 这也称为旧版缓存格式。
模型将输出与作为输入提供的缓存格式相同的格式。 如果未传递
past_key_values，则将返回旧版缓存格式。如果使用
past_key_values，用户可以选择仅输入最后一个input_ids（那些没有将其过去的键值状态提供给此模型的 input_ids），形状为(batch_size, 1)，而不是所有形状为(batch_size, sequence_length)的input_ids。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor, optional) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。 如果您想要比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联向量，这将非常有用。 - use_cache (
bool, optional) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（请参阅past_key_values）。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而不是普通 tuple。 - cache_position (形状为
(sequence_length)的torch.LongTensor, optional) — 描述输入序列 token 在序列中位置的索引。 与position_ids相反，此张量不受填充的影响。 它用于在正确的位置更新缓存并推断完整的序列长度。
CohereModel 的 forward 方法，覆盖了 __call__ 特殊方法。
尽管 forward 传递的配方需要在该函数内定义，但应该在之后调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会默默地忽略它们。
CohereForCausalLM
forward
< source >( input_ids: LongTensor = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Union[typing.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 return_dict: 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 (形状为
(batch_size, sequence_length)的torch.LongTensor) — 词汇表中输入序列 tokens 的索引。如果您提供填充，默认情况下填充将被忽略。索引可以使用 AutoTokenizer 获得。 参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详情。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 掩码，用于避免在填充 token 索引上执行注意力机制。掩码值在[0, 1]中选择：- 1 表示 未被掩盖 的 tokens，
- 0 表示 已被掩盖 的 tokens。
索引可以使用 AutoTokenizer 获得。 参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详情。
如果使用
past_key_values，则可以选择仅输入最后的input_ids（请参阅past_key_values）。如果您想更改填充行为，您应该阅读
modeling_opt._prepare_decoder_attention_mask并根据您的需要进行修改。 有关默认策略的更多信息，请参见 论文 中的图 1。- 1 表示 head 是 未被掩盖的，
- 0 表示 head 是 已被掩盖的。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 位置嵌入中每个输入序列 tokens 的位置索引。 在范围[0, config.n_positions - 1]中选择。 - past_key_values (
Cache或tuple(tuple(torch.FloatTensor)), 可选) — 预先计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），可用于加速顺序解码。 这通常包括模型在先前解码阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为
config.n_layers的tuple(tuple(torch.FloatTensor))元组，每个元组具有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量）。 这也称为旧版缓存格式。
模型将输出与作为输入馈送的缓存格式相同的格式。 如果未传递
past_key_values，则将返回旧版缓存格式。如果使用
past_key_values，用户可以选择仅输入最后的input_ids（那些没有将其过去的键值状态提供给此模型的输入 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。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。 - cache_position (形状为
(sequence_length)的torch.LongTensor，可选) — 索引，描述输入序列 tokens 在序列中的位置。 与position_ids相反，此张量不受填充的影响。 它用于在正确的位置更新缓存并推断完整的序列长度。 - labels (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 用于计算掩码语言建模损失的标签。 索引应为[0, ..., config.vocab_size]或 -100 （请参阅input_ids文档字符串）。 索引设置为-100的 tokens 将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]中的 tokens 计算。 - logits_to_keep (
int或torch.Tensor，可选) — 如果是int，则计算最后logits_to_keep个 tokens 的 logits。 如果为0，则计算所有input_ids的 logits（特殊情况）。 只有最后一个 token logits 是生成所需的，并且仅针对该 token 计算它们可以节省内存，这对于长序列或大词汇量大小而言变得非常重要。 如果是torch.Tensor，则必须是与序列长度维度中要保留的索引相对应的 1D 张量。 这在使用打包张量格式（批次和序列长度的单个维度）时很有用。
返回值
transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
transformers.modeling_outputs.CausalLMOutputWithPast 或 torch.FloatTensor 的元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，其中包含取决于配置 (CohereConfig) 和输入的各种元素。
-
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头的预测分数（SoftMax 之前每个词汇表 token 的分数）。 -
past_key_values (
tuple(tuple(torch.FloatTensor)), 可选，当传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的tuple(tuple(torch.FloatTensor))元组，每个元组具有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量）包含预先计算的隐藏状态（自注意力模块中的键和值），可以用于（请参阅
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__ 特殊方法。
尽管 forward 传递的配方需要在该函数内定义，但应该在之后调用 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."