Transformers 文档
Cohere 2
并获得增强的文档体验
开始使用
此模型发布于 2024-12-13，并于 2024-12-13 添加到 Hugging Face Transformers。
Cohere 2
Cohere Command R7B 是一个 70 亿参数模型的开放权重研究发布版。它是一个多语言模型，支持 23 种语言的训练，上下文窗口大小为 128k。该模型具有三个使用滑动窗口注意力层和 ROPE 的层，以实现高效的局部上下文建模和相对位置编码。第四层使用全局注意力，无需位置嵌入，从而实现跨整个序列的无限制标记交互。
该模型针对速度、成本效益和计算资源进行了优化。
您可以在 Command Models 集合下找到所有原始 Command-R 检查点。
点击侧边栏右侧的 Cohere 模型，了解更多关于如何将 Cohere 应用于不同语言任务的示例。
以下示例演示了如何使用 Pipeline 或 AutoModel 类以及命令行来生成文本。
import torch
from transformers import pipeline
pipeline = pipeline(
task="text-generation",
model="CohereLabs/c4ai-command-r7b-12-2024",
dtype=torch.float16,
device_map=0
)
messages = [
{"role": "user", "content": "Hello, can you please help me book a hotel in Japan?"},
]
pipeline(messages)量化通过以较低精度表示权重来减少大型模型的内存负担。有关更多可用量化后端，请参阅量化概述。
以下示例使用 bitsandbytes 将权重量化为 4 位。
import torch
from transformers import BitsAndBytesConfig, AutoTokenizer, AutoModelForCausalLM
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",
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": "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 >( vocab_size: int | None = 256000 hidden_size: int | None = 8192 intermediate_size: int | None = 22528 logit_scale: float | None = 0.0625 num_hidden_layers: int | None = 40 num_attention_heads: int | None = 64 num_key_value_heads: int | None = None hidden_act: str | None = 'silu' max_position_embeddings: int | None = 8192 initializer_range: float | None = 0.02 layer_norm_eps: int | None = 1e-05 use_cache: int | None = True pad_token_id: int | None = 0 bos_token_id: int | None = 5 eos_token_id: int | None = 255001 tie_word_embeddings: bool | None = True rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict[str, transformers.modeling_rope_utils.RopeParameters] | None = None attention_bias: bool | None = False attention_dropout: float | None = 0.0 sliding_window: int | None = 4096 layer_types: list[str] | None = None **kwargs )
参数
- vocab_size (
int, optional, defaults to 256000) — Cohere 模型词汇表大小。定义传递给 CohereModel 的inputs_ids所能表示的不同标记的数量。 - hidden_size (
int, optional, defaults to 8192) — 隐藏表示的维度。 - intermediate_size (
int, optional, defaults to 22528) — MLP 的维度。 - logit_scale (
float, optional, defaults to 0.0625) — 输出 logits 的缩放因子。 - num_hidden_layers (
int, optional, defaults to 40) — Transformer 解码器中的隐藏层数。 - num_attention_heads (
int, optional, defaults to 64) — Transformer 解码器中每个注意力层的注意力头数。 - num_key_value_heads (
int, optional) — 这是实现分组查询注意力（Grouped Query Attention）所需的 key_value 头数。如果num_key_value_heads=num_attention_heads，模型将使用多头注意力（MHA）；如果num_key_value_heads=1，模型将使用多查询注意力（MQA）；否则使用 GQA。在将多头检查点转换为 GQA 检查点时，每个组的键和值头都应通过平均池化所有组内的原始头来构建。有关更多详细信息，请参阅 本文档。如果未指定，则默认为num_attention_heads。 - hidden_act (
strorfunction, optional, defaults to"silu") — 解码器中的非线性激活函数（函数或字符串）。 - max_position_embeddings (
int, optional, defaults to 8192) — 该模型可能使用的最大序列长度。 - initializer_range (
float, optional, defaults to 0.02) — 初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - layer_norm_eps (
float, optional, defaults to 1e-05) — 层归一化使用的 epsilon。 - use_cache (
bool, optional, defaults toTrue) — 模型是否应返回最后一个键/值注意力（并非所有模型都使用）。仅在config.is_decoder=True时相关。 - pad_token_id (
int, optional, defaults to 0) — 填充标记 ID。 - bos_token_id (
int, optional, defaults to 5) — 流的开始标记 ID。 - eos_token_id (
int, optional, defaults to 255001) — 流的结束标记 ID。 - tie_word_embeddings (
bool, optional, defaults toTrue) — 是否绑定词嵌入 - rope_parameters (
RopeParameters, optional) — 包含 RoPE 嵌入配置参数的字典。该字典应包含rope_theta的值，如果需要使用更长的max_position_embeddings来缩放 RoPE，则可以选择性包含用于缩放的参数。 - attention_bias (
bool, defaults toFalse, optional, defaults toFalse) — 在自注意力期间是否在查询、键、值和输出投影层中使用偏置。 - attention_dropout (
float, optional, defaults to 0.0) — 注意力概率的 dropout 比率。 - sliding_window (
int, optional, defaults to 4096) — 滑动窗口注意力的上下文大小。 - layer_types (
list, optional) — 每个层的注意力模式。
这是用于存储 CohereModel 配置的配置类。它用于根据指定的参数实例化 Cohere 模型，定义模型架构。
配置对象继承自 PreTrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PreTrainedConfig 的文档。使用默认值实例化配置将产生与 CohereForAI/c4ai-command-r-v01 模型相似的配置。
>>> 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() 方法以加载模型权重。
该模型输出原始的隐藏状态，没有任何特定的顶部头部。
此模型继承自 PreTrainedModel。查看其父类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< source >( 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 cache_position: torch.LongTensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor, shape(batch_size, sequence_length), optional) — Vocabulary中输入序列token的索引。默认会忽略填充（padding）。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor, shape(batch_size, sequence_length), optional) — 用于避免对填充 token 进行注意力计算的掩码。掩码值选择在[0, 1]中：- 1 表示未被掩码的 token，
- 0 表示被掩码的 token。
- position_ids (
torch.LongTensor, shape(batch_size, sequence_length), optional) — 位置嵌入中每个输入序列 token 的位置索引。选择范围为[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache, optional) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键值）。可以用于加速顺序解码。通常由模型在之前的解码阶段返回，当use_cache=True或config.use_cache=True时。仅允许输入 Cache 实例，请参阅我们的 kv cache 指南。如果不提供
past_key_values，默认将初始化 DynamicCache。模型将输出与输入相同的缓存格式。
如果使用
past_key_values，则用户需要仅输入未处理的input_ids（即其 past key value 状态未传递给此模型的那些），形状为(batch_size, unprocessed_length)，而不是所有input_ids（形状为(batch_size, sequence_length)）。 - inputs_embeds (
torch.FloatTensor, shape(batch_size, sequence_length, hidden_size), optional) — 可选地，您可以直接传入嵌入表示，而不是传入input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - use_cache (
bool, optional) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（请参阅past_key_values）。 - cache_position (
torch.LongTensor, shape(sequence_length), optional) — 描述输入序列 token 在序列中位置的索引。与position_ids不同，此张量不受填充影响。它用于在正确的位置更新缓存并推断完整序列长度。
返回
transformers.modeling_outputs.BaseModelOutputWithPast or tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置（Cohere2Config）和输入而定的各种元素。
-
last_hidden_state (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。如果使用了
past_key_values，则只输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。 -
past_key_values (
Cache, optional, 当传递use_cache=True或当config.use_cache=True时返回) — 它是 Cache 实例。更多详情，请参阅我们的 kv cache 指南。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 后的注意力权重，用于计算自注意力头中的加权平均值。
Cohere2Model 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
Cohere2ForCausalLM
class transformers.Cohere2ForCausalLM
< source >( 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
< source >( 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 output_attentions: bool | None = None output_hidden_states: bool | None = None cache_position: torch.LongTensor | None = None logits_to_keep: int | torch.Tensor = 0 **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor, shape(batch_size, sequence_length), optional) — Vocabulary中输入序列token的索引。默认会忽略填充（padding）。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
torch.Tensor, shape(batch_size, sequence_length), optional) — 用于避免对填充 token 进行注意力计算的掩码。掩码值选择在[0, 1]中：- 1 表示未被掩码的 token，
- 0 表示被掩码的 token。
- position_ids (
torch.LongTensor, shape(batch_size, sequence_length), optional) — 位置嵌入中每个输入序列 token 的位置索引。选择范围为[0, config.n_positions - 1]。 - past_key_values (
~cache_utils.Cache, optional) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键值）。可以用于加速顺序解码。通常由模型在之前的解码阶段返回，当use_cache=True或config.use_cache=True时。仅允许输入 Cache 实例，请参阅我们的 kv cache 指南。如果不提供
past_key_values，默认将初始化 DynamicCache。模型将输出与输入相同的缓存格式。
如果使用
past_key_values，则用户需要仅输入未处理的input_ids（即其 past key value 状态未传递给此模型的那些），形状为(batch_size, unprocessed_length)，而不是所有input_ids（形状为(batch_size, sequence_length)）。 - inputs_embeds (
torch.FloatTensor, shape(batch_size, sequence_length, hidden_size), optional) — 可选地，您可以直接传入嵌入表示，而不是传入input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联的向量，这将非常有用。 - labels (
torch.LongTensor, shape(batch_size, sequence_length), optional) — 用于计算掩码语言建模损失的标签。索引应在[0, ..., config.vocab_size]或 -100 之间（请参阅input_ids文档字符串）。索引设置为-100的 token 将被忽略（掩码），损失仅为标签在[0, ..., config.vocab_size]范围内的 token 计算。 - use_cache (
bool, optional) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（请参阅past_key_values）。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回的张量下的hidden_states。 - cache_position (
torch.LongTensor, 形状为(sequence_length), optional) — 指示输入序列 token 在序列中位置的索引。与position_ids不同，此张量不受 padding 的影响。它用于将缓存更新到正确的位置并推断完整的序列长度。 - logits_to_keep (
Union[int, torch.Tensor], optional, defaults to0) — 如果为int，则计算最后logits_to_keep个 token 的 logits。如果为0，则计算所有input_ids的 logits（特殊情况）。对于生成任务，只需要最后一个 token 的 logits，并且只为该 token 计算 logits 可以节省内存，这对于长序列或大词汇量来说非常重要。如果为torch.Tensor，则必须是一维的，对应于序列长度维度中的要保留的索引。当使用打包张量格式（批次和序列长度的单维度）时，这很有用。
返回
transformers.modeling_outputs.CausalLMOutputWithPast or tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithPast 或一个元组（如果传递了 return_dict=False 或当 config.return_dict=False 时）torch.FloatTensor，其中包含根据配置（Cohere2Config）和输入而变化的各种元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
past_key_values (
Cache, optional, 当传递use_cache=True或当config.use_cache=True时返回) — 它是 Cache 实例。更多详情，请参阅我们的 kv cache 指南。包含预计算的隐藏状态（自注意力块中的键和值），可用于（参见
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 后的注意力权重，用于计算自注意力头中的加权平均值。
Cohere2ForCausalLM 的 forward 方法覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>> 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."