Transformers 文档
Cohere 2
并获得增强的文档体验
开始使用
该模型于 2024 年 12 月 13 日被贡献给 Hugging Face Transformers。
Cohere 2
Cohere Command R7B 是一款参数量为 70 亿的开源权重研究发布模型。它是一个多语言模型，在 23 种语言上进行训练，并拥有 128k 的上下文窗口。该模型具有三层带有滑动窗口注意力机制（sliding window attention）的层，以及用于高效局部上下文建模和相对位置编码的旋转位置嵌入（ROPE）。第四层使用无位置嵌入的全局注意力机制，实现了跨整个序列的无限制 token 交互。
该模型针对速度、性价比和计算资源进行了优化。
你可以在 Command Models 合集中找到所有原始的 Command-R 检查点。
点击右侧边栏中的 Cohere 模型，查看更多关于如何将 Cohere 应用于不同语言任务的示例。
下面的示例演示了如何使用 Pipeline 或 AutoModel 类以及从命令行生成文本。
from transformers import pipeline
pipeline = pipeline(
task="text-generation",
model="CohereLabs/c4ai-command-r7b-12-2024",
device_map=0
)
messages = [
{"role": "user", "content": "Hello, can you please help me book a hotel in Japan?"},
]
pipeline(messages)量化通过以较低精度表示权重来减少大型模型的内存负担。有关更多可用量化后端，请参阅量化概述。
以下示例使用 bitsandbytes 将权重量化为 4 位。
from transformers import AutoModelForCausalLM, AutoTokenizer, BitsAndBytesConfig
bnb_config = BitsAndBytesConfig(load_in_4bit=True)
tokenizer = AutoTokenizer.from_pretrained("CohereLabs/c4ai-command-r7b-12-2024")
model = AutoModelForCausalLM.from_pretrained(
"CohereLabs/c4ai-command-r7b-12-2024",
device_map="auto",
quantization_config=bnb_config,
attn_implementation="sdpa"
)
# format message with the Command-R chat template
messages = [{"role": "user", "content": "Hello, can you please help me book a hotel in Japan?"}]
input_ids = tokenizer.apply_chat_template(messages, tokenize=True, add_generation_prompt=True, return_tensors="pt").to(model.device)
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))Cohere2Config
class transformers.Cohere2Config
< source >( transformers_version: str | None = None architectures: list[str] | None = None output_hidden_states: bool | None = False return_dict: bool | None = True dtype: typing.Union[str, ForwardRef('torch.dtype'), NoneType] = 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: typing.Optional[typing.Literal['regression', 'single_label_classification', 'multi_label_classification']] = None vocab_size: int = 256000 hidden_size: int = 8192 intermediate_size: int = 22528 logit_scale: float = 0.0625 num_hidden_layers: int = 40 num_attention_heads: int = 64 num_key_value_heads: int | None = None hidden_act: str = 'silu' max_position_embeddings: int = 8192 initializer_range: float = 0.02 layer_norm_eps: float = 1e-05 use_cache: bool = True pad_token_id: int | None = 0 bos_token_id: int | None = 5 eos_token_id: int | list[int] | None = 255001 tie_word_embeddings: bool = True rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = None attention_bias: bool = False attention_dropout: float | int = 0.0 sliding_window: int | None = 4096 layer_types: list[str] | None = None )
参数
- vocab_size (
int, 可选, 默认为256000) — 模型的词汇表大小。定义了input_ids可以表示的不同 token 的数量。 - hidden_size (
int, 可选, 默认为8192) — 隐藏层表示的维度。 - intermediate_size (
int, 可选, 默认为22528) — MLP 表示的维度。 - logit_scale (
float, 可选, 默认为 0.0625) — 输出 logit 的缩放因子。 - 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，模型将使用多头注意力（MHA）；如果num_key_value_heads=1，模型将使用多查询注意力（MQA）；否则使用 GQA。在将多头检查点转换为 GQA 检查点时，每个组的 key 和 value 头应通过对该组内的所有原始头进行均值池化来构建。更多详细信息，请查看这篇论文。如果未指定，将默认为num_attention_heads。 - hidden_act (
str, 可选, 默认为silu) — 解码器中的非线性激活函数（函数或字符串）。例如："gelu","relu","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) — 词汇表中用于填充的 token id。 - bos_token_id (
int, 可选, 默认为5) — 词汇表中用于流开始（beginning-of-stream）的 token id。 - eos_token_id (
Union[int, list[int]], 可选, 默认为255001) — 词汇表中用于流结束（end-of-stream）的 token id。 - tie_word_embeddings (
bool, 可选, 默认为True) — 是否根据模型的tied_weights_keys映射来绑定权重嵌入。 - rope_parameters (
Union[~modeling_rope_utils.RopeParameters, dict], 可选) — 包含 RoPE 嵌入配置参数的字典。该字典应包含rope_theta的值，以及（可选的）用于缩放的参数，以防你想在更长的max_position_embeddings下使用 RoPE。 - attention_bias (
bool, 可选, 默认为False) — 是否在自注意力期间使用 query、key、value 和输出投影层中的偏置。 - attention_dropout (
Union[float, int], 可选, 默认为0.0) — 注意力概率的 dropout 比率。 - sliding_window (
int, 可选, 默认为4096) — 滑动窗口注意力的窗口大小。如果为None，则不应用滑动窗口。 - layer_types (
list[str], 可选) — 一个显式映射每个层索引及其层类型的列表。如果未提供，它将根据配置值自动生成。
这是用于存储 Cohere2Model 配置的配置类。它用于根据指定的参数实例化 Cohere2 模型，定义模型架构。使用默认值实例化配置将得到与 CohereForAI/c4ai-command-r-v01 相似的配置。
配置对象继承自 PreTrainedConfig，可用于控制模型输出。阅读 PreTrainedConfig 的文档以获取更多信息。
>>> from transformers import Cohere2Model, Cohere2Config
>>> # Initializing a Cohere Nextmodel configuration
>>> configuration = Cohere2Config()
>>> # Initializing a model from the Cohere2 configuration
>>> model = Cohere2Model(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configCohere2Model
class transformers.Cohere2Model
< source >( config: Cohere2Config )
参数
- config (Cohere2Config) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
输出原始隐藏状态且顶部没有任何特定头部的基础 Cohere2 模型。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源代码 >( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None use_cache: bool | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (shape为
(batch_size, sequence_length)的torch.LongTensor，可选) — 词汇表中输入序列标记的索引。默认情况下，填充（Padding）将被忽略。可以使用 AutoTokenizer 获取索引。详情请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (shape为
(batch_size, sequence_length)的torch.Tensor，可选) — 用于避免对填充标记索引执行注意力计算的掩码。掩码值选自[0, 1]：- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
- position_ids (shape为
(batch_size, sequence_length)的torch.LongTensor，可选) — 每个输入序列标记在位置嵌入中的位置索引。选自范围[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache，可选) — 预计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），可用于加速顺序解码。这通常由模型在解码的前一阶段返回，当use_cache=True或config.use_cache=True时使用。仅允许使用 Cache 实例作为输入，请参阅我们的 kv 缓存指南。如果未传递
past_key_values，将默认初始化 DynamicCache。模型将输出与输入相同格式的缓存。
如果使用了
past_key_values，用户应仅输入未处理的input_ids（即未将其过去键值状态提供给此模型的输入），其 shape 为(batch_size, unprocessed_length)，而不是所有input_ids（shape 为(batch_size, sequence_length)）。 - inputs_embeds (shape为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你想比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联向量，这会很有用。 - use_cache (
bool，可选) — 如果设置为True，则返回past_key_values键值状态，并可用于加速解码（参见past_key_values）。
返回
BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
一个 BaseModelOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（Cohere2Config）和输入，包含各种元素。
Cohere2Model 的 forward 方法，重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
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 缓存指南。Contains pre-computed hidden-states (key and values in the self-attention blocks and optionally if
config.is_encoder_decoder=Truein the cross-attention blocks) that can be used (seepast_key_valuesinput) to speed up sequential decoding.hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
Cohere2ForCausalLM
class transformers.Cohere2ForCausalLM
< 源代码 >( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )
参数
- config (Cohere2ForCausalLM) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
用于因果语言建模的 Cohere2 模型。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源代码 >( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None use_cache: bool | None = None logits_to_keep: int | torch.Tensor = 0 **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → CausalLMOutputWithPast or tuple(torch.FloatTensor)
参数
- input_ids (shape为
(batch_size, sequence_length)的torch.LongTensor，可选) — 词汇表中输入序列标记的索引。默认情况下，填充（Padding）将被忽略。可以使用 AutoTokenizer 获取索引。详情请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (shape为
(batch_size, sequence_length)的torch.Tensor，可选) — 用于避免对填充标记索引执行注意力计算的掩码。掩码值选自[0, 1]：- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
- position_ids (shape为
(batch_size, sequence_length)的torch.LongTensor，可选) — 每个输入序列标记在位置嵌入中的位置索引。选自范围[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache，可选) — 预计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），可用于加速顺序解码。这通常由模型在解码的前一阶段返回，当use_cache=True或config.use_cache=True时使用。仅允许使用 Cache 实例作为输入，请参阅我们的 kv 缓存指南。如果未传递
past_key_values，将默认初始化 DynamicCache。模型将输出与输入相同格式的缓存。
如果使用了
past_key_values，用户应仅输入未处理的input_ids（即未将其过去键值状态提供给此模型的输入），其 shape 为(batch_size, unprocessed_length)，而不是所有input_ids（shape 为(batch_size, sequence_length)）。 - inputs_embeds (shape为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你想比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联向量，这会很有用。 - labels (shape为
(batch_size, sequence_length)的torch.LongTensor，可选) — 用于计算掩码语言建模损失的标签。索引应在[0, ..., config.vocab_size]范围内或为 -100（参见input_ids文档字符串）。索引设为-100的标记将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]范围内的标记计算。 - use_cache (
bool，可选) — 如果设置为True，则返回past_key_values键值状态，并可用于加速解码（参见past_key_values）。 - logits_to_keep (
Union[int, torch.Tensor]，可选，默认为0) — 如果为int，则计算最后logits_to_keep个标记的 Logits。如果为0，则计算所有input_ids的 Logits（特殊情况）。生成时仅需要最后标记的 Logits，仅为该标记计算 Logits 可以节省内存，对于长序列或大词汇量的情况，这一点非常重要。如果为torch.Tensor，则必须是对应于序列长度维度中要保留的索引的一维张量。这在使用打包张量格式（batch 和序列长度为单一维度）时非常有用。
返回
CausalLMOutputWithPast or tuple(torch.FloatTensor)
一个 CausalLMOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（Cohere2Config）和输入，包含各种元素。
Cohere2ForCausalLM 的 forward 方法，重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
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), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
示例
>> from transformers import AutoTokenizer, Cohere2ForCausalLM
>> model = Cohere2ForCausalLM.from_pretrained("Cohere2ForAI/c4ai-command-r-v01")
>> tokenizer = AutoTokenizer.from_pretrained("Cohere2ForAI/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."