Transformers 文档

Cohere

Hugging Face's logo
加入 Hugging Face 社区

并获取增强版文档体验

开始使用

Cohere

概述

Cohere Command-R 模型在 Cohere 团队的博客文章 Command-R:生产规模的检索增强生成 中提出。

论文摘要如下:

Command-R 是一款可扩展的生成模型,其目标是 RAG 和工具使用,以实现企业级生产规模的 AI。今天,我们推出了 Command-R,一款针对大型生产工作负载的新型 LLM。Command-R 针对的是新兴的“可扩展”模型类别,这些模型在高效率和高准确性之间取得了平衡,使公司能够超越概念验证阶段,进入生产阶段。

*Command-R 是一款为长上下文任务(如检索增强生成 (RAG) 和使用外部 API 和工具)优化的生成模型。它旨在与我们业界领先的 Embed 和 Rerank 模型协同工作,为 RAG 应用程序提供一流的集成,并在企业用例中表现出色。作为一个专为公司大规模实施而构建的模型,Command-R 拥有以下优势:*

  • 在 RAG 和工具使用方面具有很高的准确性
  • 低延迟,高吞吐量
  • 更长的 128k 上下文和更低的价格
  • 在 10 种主要语言中具有强大的功能
  • 模型权重可在 HuggingFace 上获得,用于研究和评估

查看模型检查点 此处。该模型由 Saurabh DashAhmet Üstün 贡献。Hugging Face 中实现的代码基于 GPT-NeoX 此处

使用技巧

在 Hub 上上传的检查点使用 torch_dtype = 'float16'AutoModel API 将使用它将检查点从 torch.float32 转换为 torch.float16

在线权重的 dtype 大多无关紧要,除非您在使用 torch_dtype="auto" 初始化模型时使用 model = AutoModelForCausalLM.from_pretrained("path", 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 时,只需将 fp16bf16 指定为 True。否则,请确保您使用的是 torch.autocast。这是必需的,因为 Flash Attention 仅支持 fp16bf16 数据类型。

资源

以下是一些官方 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

< >

( 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 可以表示的不同令牌的数量
  • 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, 可选) — 这是用于实现分组查询注意力的键值头数量。 如果 num_key_value_heads=num_attention_heads,模型将使用多头注意力 (MHA),如果 num_key_value_heads=1,模型将使用多查询注意力 (MQA),否则将使用 GQA。 将多头检查点转换为 GQA 检查点时,每个组键和值头应通过对该组中所有原始头的平均池化来构建。 有关更多详细信息,请查看 这篇论文。 如果未指定,将默认设置为 num_attention_heads
  • hidden_act (strfunction, 可选, 默认值 "silu") — 解码器中的非线性激活函数(函数或字符串)。
  • max_position_embeddings (int, 可选, 默认值 8192) — 该模型可能使用的最大序列长度。
  • initializer_range (float, 可选, 默认值 0.02) — 用于初始化所有权重矩阵的截断正态初始化的标准差。
  • layer_norm_eps (float, 可选, 默认值 1e-05) — 层归一化使用的epsilon。
  • 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 (strtokenizers.AddedToken, 可选, 默认值为 "<UNK>") — 未知标记。词汇表中没有的标记无法转换为 ID,而是设置为此标记。
  • bos_token (strtokenizers.AddedToken, 可选, 默认值为 "<BOS_TOKEN>") — 在预训练期间使用的序列开始标记。可以用作序列分类标记。
  • eos_token (strtokenizers.AddedToken, 可选, 默认值为 "<|END_OF_TURN_TOKEN|>") — 序列结束标记。
  • add_eos_token (bool, optional, defaults to False) — 是否在序列末尾添加 eos_token
  • use_default_system_prompt (bool, optional, defaults to False) — 是否使用 Cohere 分词器的默认系统提示。
  • add_prefix_space (bool, optional, defaults to False) — 分词器是否应自动添加前缀空格

构建 Cohere 分词器。 基于字节级字节对编码。

这使用字节回退和 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_tokeneos_token,请确保在初始化模型时指定它们,或调用 tokenizer.update_post_processor() 以确保正确执行后处理(否则编码序列的第一个标记和最后一个标记的值将不正确)。有关更多详细信息,请查看 [后处理器] (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: Optional = None already_has_special_tokens: bool = False ) 0 到 1 之间的整数列表

参数

  • token_ids_0 (List[int]) — 第一个序列的 ID 列表。
  • token_ids_1 (List[int], optional) — 第二个序列的 ID 列表。
  • already_has_special_tokens (bool, optional, defaults to False) — 标记列表是否已使用模型的特殊标记格式化。

返回值

0 到 1 之间的整数列表

特殊标记为 1,序列标记为 0。

从没有添加特殊标记的标记列表中检索序列 ID。此方法在使用分词器 prepare_for_modelencode_plus 方法添加特殊标记时调用。

create_token_type_ids_from_sequences

< >

( token_ids_0: 列表 token_ids_1: 可选 = None ) 列表[int]

参数

  • token_ids_0 (列表[int]) — 第一个分词后的序列。
  • token_ids_1 (列表[int], 可选) — 第二个分词后的序列。

返回值

列表[int]

分词类型 ID。

创建对应于传入序列的分词类型 ID。 什么是分词类型 ID?

如果模型有构建这些 ID 的特殊方法,则应在子类中覆盖此方法。

update_post_processor

< >

( )

使用当前的 bos_tokeneos_token 更新基础的后处理程序。

save_vocabulary

< >

( save_directory: str filename_prefix: 可选 = None ) 元组(str)

参数

  • save_directory (str) — 保存词表的目录。
  • filename_prefix (str, 可选) — 要添加到保存的文件名称的可选前缀。

返回值

元组(str)

保存的文件的路径。

仅保存分词器的词表(词表 + 添加的词元)。

此方法不会保存分词器的配置和特殊词元映射。使用 _save_pretrained() 来保存分词器的整个状态。

CohereModel

transformers.CohereModel

< >

( config: CohereConfig )

参数

  • config (CohereConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,只会加载配置。查看 from_pretrained() 方法来加载模型权重。config — CohereConfig

输出原始隐藏状态的 Cohere 模型,没有任何特定的头部。此模型继承自 PreTrainedModel。查看超类文档,了解库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小等)。

此模型也是 PyTorch torch.nn.Module 子类。将其用作常规的 PyTorch 模块,并参考 PyTorch 文档了解与一般使用和行为相关的所有内容。

包含 config.num_hidden_layers 层的 Transformer 解码器。每层都是一个 CohereDecoderLayer

forward

< >

( input_ids: LongTensor = None attention_mask: Optional = None position_ids: Optional = None past_key_values: Union = None inputs_embeds: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None cache_position: Optional = None )

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 输入序列词元在词汇表中的索引。 如果你提供了填充,默认情况下填充会被忽略。

    索引可以通过 AutoTokenizer 获得。 详情请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

  • attention_mask (torch.Tensor 形状为 (batch_size, sequence_length), 可选) — 掩码,用于避免对填充词元索引执行注意力。 掩码值选择在 [0, 1] 内:

    • 1 表示 未掩码 的词元,
    • 0 表示 掩码 的词元。

    什么是注意力掩码?

    索引可以通过 AutoTokenizer 获得。 详情请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    如果你使用了 past_key_values,可选地只需要输入最后的 input_ids(那些没有被提供给该模型的过去键值状态的词元)形状为 (batch_size, 1),而不是所有 input_ids 形状为 (batch_size, sequence_length)

    如果你想改变填充行为,你应该阅读 modeling_opt._prepare_decoder_attention_mask 并根据你的需求进行修改。 详情请参阅 论文 中的图 1,以了解更多关于默认策略的信息。

    • 1 表示头部 未掩码
    • 0 表示头部 掩码
  • position_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 输入序列词元在位置嵌入中的位置索引。 选择在 [0, config.n_positions - 1] 范围内。

    什么是位置 ID?

  • past_key_values (Cachetuple(tuple(torch.FloatTensor)), 可选) — 预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。 这通常包括模型在解码的先前阶段返回的 past_key_values,当 use_cache=Trueconfig.use_cache=True 时。

    允许两种格式:

    • 一个 Cache 实例,请参阅我们的 kv 缓存指南
    • tuple(torch.FloatTensor) 的元组,长度为 config.n_layers,每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量。 这也被称为传统缓存格式。

    模型将输出与输入相同的缓存格式。 如果没有传入 past_key_values,则将返回传统缓存格式。

    如果你使用了 past_key_values,用户可以选择仅输入最后的 input_ids(那些没有被提供给该模型的过去键值状态的词元),形状为 (batch_size, 1),而不是所有 input_ids 形状为 (batch_size, sequence_length)

  • inputs_embeds (torch.FloatTensor 形状为 (batch_size, sequence_length, hidden_size), 可选) — 可选地,你可以选择直接传入嵌入表示,而不是传入 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 而不是一个普通的元组。

The CohereModel forward method, overrides the __call__ special method.

虽然正向传递的配方需要在此函数中定义,但应该随后调用 Module 实例,而不是此实例,因为前者负责运行前处理和后处理步骤,而后者会默默忽略它们。

CohereForCausalLM

class transformers.CohereForCausalLM

< >

( config )

forward

< >

( input_ids: LongTensor = None attention_mask: Optional = None position_ids: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None cache_position: Optional = None num_logits_to_keep: int = 0 ) transformers.modeling_outputs.CausalLMOutputWithPasttuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor 形状为 (batch_size, sequence_length)) — 词汇表中输入序列令牌的索引。如果您提供填充,默认情况下将忽略填充。

    索引可以使用 AutoTokenizer 获得。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是输入 ID?

  • attention_mask (torch.Tensor 形状为 (batch_size, sequence_length), 可选) — 掩码以避免对填充令牌索引执行注意力。在 [0, 1] 中选择掩码值:

    • 1 表示 未掩码 的令牌,
    • 0 表示 掩码 的令牌。

    什么是注意力掩码?

    索引可以使用 AutoTokenizer 获得。有关详细信息,请参阅 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    如果使用 past_key_values,则可以选择仅输入最后的 input_ids(参见 past_key_values)。

    如果您想更改填充行为,您应该阅读 modeling_opt._prepare_decoder_attention_mask 并根据您的需要进行修改。有关默认策略的更多信息,请参见 论文 中的图 1。

    • 1 表示头部 未掩码
    • 0 表示头部 掩码
  • position_ids (torch.LongTensor 形状为 (batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列令牌的位置索引。在 [0, config.n_positions - 1] 范围内选择。

    什么是位置 ID?

  • past_key_values (Cachetuple(tuple(torch.FloatTensor)), 可选) — 预先计算的隐藏状态(自注意力块和交叉注意力块中的键和值),可用于加速顺序解码。 这通常包括模型在解码的先前阶段返回的 past_key_values,当 use_cache=Trueconfig.use_cache=True 时。

    允许两种格式:

    • 一个 Cache 实例,请参阅我们的 kv 缓存指南;
    • 长度为 config.n_layerstuple(torch.FloatTensor) 元组,每个元组包含两个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量)。 这也称为传统缓存格式。

    模型将输出与输入相同的缓存格式。 如果未传入 past_key_values,则将返回传统缓存格式。

    如果使用 past_key_values,用户可以选择仅输入形状为 (batch_size, 1) 的最后一个 input_ids(那些没有提供给此模型的过去键值状态的 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
  • return_dict (bool, 可选) — 是否返回一个 ModelOutput,而不是一个普通元组。

    参数 — labels (形状为 (batch_size, sequence_length)torch.LongTensor, 可选): 用于计算掩码语言建模损失的标签。 索引应为 [0, ..., config.vocab_size] 或 -100(请参阅 input_ids 文档字符串)。 索引设置为 -100 的令牌将被忽略(掩码),仅针对标签位于 [0, ..., config.vocab_size] 中的令牌计算损失。

    num_logits_to_keep (int, 可选): 计算最后 num_logits_to_keep 个令牌的 logits。 如果为 0,则计算所有 input_ids 的 logits(特殊情况)。 生成仅需要最后一个令牌的 logits,并且仅计算该令牌的 logits 可以节省内存,对于较长的序列或较大的词汇量而言,这一点非常重要。

返回值

transformers.modeling_outputs.CausalLMOutputWithPasttuple(torch.FloatTensor)

一个 transformers.modeling_outputs.CausalLMOutputWithPast 或一个 torch.FloatTensor 元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含各种元素,具体取决于配置 (CohereConfig) 和输入。

  • loss (形状为 (1,)torch.FloatTensor, 可选, 当提供 labels 时返回) — 语言建模损失(用于下一个令牌预测)。

  • logits (形状为 (batch_size, sequence_length, config.vocab_size)torch.FloatTensor) — 语言建模头的预测分数(SoftMax 之前的每个词汇量令牌的分数)。

  • past_key_values (tuple(tuple(torch.FloatTensor)), 可选, 当传递 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layerstuple(torch.FloatTensor) 元组,每个元组包含两个形状为 (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 正向方法重写了 __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 上更新