Transformers 文档
Ministral
并获得增强的文档体验
开始使用
此模型于 2025 年 9 月 11 日贡献给 Hugging Face Transformers。
Ministral
Ministral 是一款 8B 参数的语言模型，它通过交替注意力模式扩展了 Mistral 架构。与始终使用完整注意力或滑动窗口注意力的 Mistral 不同，Ministral 在完整注意力层和滑动窗口注意力层之间交替，模式为 1 层完整注意力后接 3 层滑动窗口注意力。这使得它能够支持 128K 的上下文长度。
该架构与 Qwen2 不谋而合，主要区别在于 Ministral 在注意力投影中使用了偏置（biases）。
您可以在 Mistral AI 组织下找到 Ministral 的检查点（checkpoints）。
用法
下面的示例演示了如何使用 Ministral 进行文本生成
from transformers import AutoModelForCausalLM, AutoTokenizer
model = AutoModelForCausalLM.from_pretrained("mistralai/Ministral-8B-Instruct-2410", attn_implementation="sdpa", device_map="auto")
tokenizer = AutoTokenizer.from_pretrained("mistralai/Ministral-8B-Instruct-2410")
messages = [
{"role": "user", "content": "What is your favourite condiment?"},
{"role": "assistant", "content": "Well, I'm quite partial to a good squeeze of fresh lemon juice. It adds just the right amount of zesty flavour to whatever I'm cooking up in the kitchen!"},
{"role": "user", "content": "Do you have mayonnaise recipes?"}
]
model_inputs = tokenizer.apply_chat_template(messages, return_tensors="pt").to(model.device)
generated_ids = model.generate(model_inputs, max_new_tokens=100, do_sample=True)
tokenizer.batch_decode(generated_ids)[0]
"Mayonnaise can be made as follows: (...)"MinistralConfig
class transformers.MinistralConfig
< 源码 >( 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 = 32000 hidden_size: int = 4096 intermediate_size: int = 14336 num_hidden_layers: int = 32 num_attention_heads: int = 32 num_key_value_heads: int = 8 head_dim: int | None = None hidden_act: str = 'silu' max_position_embeddings: int = 131072 initializer_range: float = 0.02 rms_norm_eps: float = 1e-06 use_cache: bool = True pad_token_id: int | None = None bos_token_id: int | None = 1 eos_token_id: int | list[int] | None = 2 tie_word_embeddings: bool = False rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = None sliding_window: int | None = 4096 attention_dropout: float | int = 0.0 layer_types: list[str] | None = None )
参数
- vocab_size (
int, 可选, 默认值为32000) — 模型的词汇表大小。定义了input_ids可以表示的不同 token 的数量。 - hidden_size (
int, 可选, 默认值为4096) — 隐藏表示的维度。 - intermediate_size (
int, 可选, 默认值为14336) — MLP 表示的维度。 - num_hidden_layers (
int, 可选, 默认值为32) — Transformer 解码器中的隐藏层数。 - num_attention_heads (
int, 可选, 默认值为32) — Transformer 解码器中每个注意力层的注意力头数。 - num_key_value_heads (
int, 可选, 默认值为8) — 这是用于实现分组查询注意力（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。 - head_dim (
int, 可选) — 注意力头维度。如果为 None，则默认为 hidden_size // num_attention_heads - hidden_act (
str, 可选, 默认值为silu) — 解码器中的非线性激活函数（函数或字符串）。例如，"gelu"、"relu"、"silu"等。 - max_position_embeddings (
int, 可选, 默认值为131072) — 此模型可能使用的最大序列长度。 - initializer_range (
float, 可选, 默认值为0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - rms_norm_eps (
float, 可选, 默认值为1e-06) — RMS 归一化层使用的 epsilon。 - use_cache (
bool, 可选, 默认值为True) — 模型是否应返回最后的 key/values 注意力（并非所有模型都使用）。仅在config.is_decoder=True或模型是仅解码器的生成模型时相关。 - pad_token_id (
int, 可选) — 词汇表中用于填充的 token id。 - bos_token_id (
int, 可选, 默认值为1) — 词汇表中用于流开始（beginning-of-stream）的 token id。 - eos_token_id (
Union[int, list[int]], 可选, 默认值为2) — 词汇表中用于流结束（end-of-stream）的 token id。 - tie_word_embeddings (
bool, 可选, 默认值为False) — 是否根据模型的tied_weights_keys映射来绑定权重嵌入。 - rope_parameters (
Union[~modeling_rope_utils.RopeParameters, dict], 可选) — 包含 RoPE 嵌入配置参数的字典。该字典应包含rope_theta的值，以及在希望使用更长的max_position_embeddings时用于缩放的可选参数。 - sliding_window (
int, 可选, 默认值为4096) — 滑动窗口注意力的窗口大小。如果为None，则不应用滑动窗口。 - attention_dropout (
Union[float, int], 可选, 默认值为0.0) — 注意力概率的 dropout 比率。 - layer_types (
list[str], 可选) — 一个明确将每个层索引映射到其层类型的列表。如果未提供，将根据配置值自动生成。
这是存储 MinistralModel 配置的配置类。它用于根据指定的参数实例化 Ministral 模型，从而定义模型架构。使用默认值实例化配置将产生与 mistralai/Ministral-8B-Instruct-2410 类似的配置。
配置对象继承自 PreTrainedConfig，可用于控制模型输出。阅读 PreTrainedConfig 的文档以获取更多信息。
示例
>>> from transformers import MinistralModel, MinistralConfig
>>> # Initializing a Ministral 8B style configuration
>>> configuration = MinistralConfig()
>>> # Initializing a model from the Ministral 8B style configuration
>>> model = MinistralModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configMinistralModel
class transformers.MinistralModel
< 源码 >( config: MinistralConfig )
参数
- config (MinistralConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
裸的 Ministral 模型，输出原始隐藏状态，顶部没有任何特定层。
该模型继承自 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 (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 词表中输入序列标记的索引。默认情况下，填充（padding）将被忽略。索引可以通过 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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]。 - past_key_values (
~cache_utils.Cache，可选) — 预先计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），可用于加速序列解码。这通常包含模型在之前解码阶段返回的past_key_values（当use_cache=True或config.use_cache=True时）。仅允许输入 Cache 实例，请参阅我们的 kv 缓存指南。如果不传入
past_key_values，则默认初始化 DynamicCache。模型将输出与输入时相同格式的缓存。
如果使用
past_key_values，用户应仅输入未经处理的input_ids（那些之前未给该模型提供键值状态的输入），形状为(batch_size, unprocessed_length)，而不是形状为(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）。
返回
BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
一个 BaseModelOutputWithPast 或一个 torch.FloatTensor 元组（如果传入了 return_dict=False 或 config.return_dict=False），根据配置 (MinistralConfig) 和输入包含不同的元素。
MinistralModel 的前向传播（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 后的注意力权重，用于计算自注意力头中的加权平均值。
MinistralForCausalLM
class transformers.MinistralForCausalLM
< 源代码 >( 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 (MinistralForCausalLM) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载模型权重，只会加载配置。请查看 from_pretrained() 方法来加载模型权重。
用于因果语言建模（causal language modeling）的 Ministral 模型。
该模型继承自 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 (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 词表中输入序列标记的索引。默认情况下，填充（padding）将被忽略。索引可以通过 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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]。 - past_key_values (
~cache_utils.Cache，可选) — 预先计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），可用于加速序列解码。这通常包含模型在之前解码阶段返回的past_key_values（当use_cache=True或config.use_cache=True时）。仅允许输入 Cache 实例，请参阅我们的 kv 缓存指南。如果不传入
past_key_values，则默认初始化 DynamicCache。模型将输出与输入时相同格式的缓存。
如果使用
past_key_values，用户应仅输入未经处理的input_ids（那些之前未给该模型提供键值状态的输入），形状为(batch_size, unprocessed_length)，而不是形状为(batch_size, sequence_length)的全部input_ids。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选) — （可选）您可以选择直接传入嵌入式表示，而不是传入input_ids。如果您想要比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联向量，这非常有用。 - labels (形状为
(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，仅为该标记计算可以节省内存，这对于长序列或大词表大小来说非常显著。如果为torch.Tensor，则必须是一维的，对应于序列长度维度中需要保留的索引。这在使用打包张量格式（batch 和序列长度的单一维度）时非常有用。
返回
CausalLMOutputWithPast or tuple(torch.FloatTensor)
一个 CausalLMOutputWithPast 或一个 torch.FloatTensor 元组（如果传入了 return_dict=False 或 config.return_dict=False），根据配置 (MinistralConfig) 和输入包含不同的元素。
MinistralForCausalLM 的前向传播（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, MinistralForCausalLM
>>> model = MinistralForCausalLM.from_pretrained("meta-ministral/Ministral-2-7b-hf")
>>> tokenizer = AutoTokenizer.from_pretrained("meta-ministral/Ministral-2-7b-hf")
>>> 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."MinistralForSequenceClassification
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 **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → SequenceClassifierOutputWithPast or tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 输入序列标记在词汇表中的索引。默认情况下，填充（padding）将被忽略。索引可以使用 AutoTokenizer 获取。详细信息请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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]。 - past_key_values (
~cache_utils.Cache，可选) — 预计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），可用于加速顺序解码。通常由模型在解码的先前阶段返回，且use_cache=True或config.use_cache=True。仅允许 Cache 实例作为输入，请参阅我们的 kv 缓存指南。如果未传递
past_key_values，默认将初始化 DynamicCache。模型将输出与输入时相同格式的缓存。
如果使用了
past_key_values，用户只需输入未处理的input_ids（即那些尚未提供给此模型的历史键值状态的标记），其形状应为(batch_size, unprocessed_length)，而非所有形状为(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）。
返回
SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)
一个 SequenceClassifierOutputWithPast 或 torch.FloatTensor 元组（如果传入了 return_dict=False 或当 config.return_dict=False 时），根据配置（None）和输入，其包含不同的元素。
The GenericForSequenceClassification forward method, overrides the __call__ special method.
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失（如果 config.num_labels==1，则为回归损失）。logits (形状为
(batch_size, config.num_labels)的torch.FloatTensor) — 分类（如果 config.num_labels==1，则为回归）分数（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 后的注意力权重，用于计算自注意力头中的加权平均值。
MinistralForTokenClassification
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 **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 输入序列标记在词汇表中的索引。默认情况下，填充将被忽略。索引可以使用 AutoTokenizer 获取。详细信息请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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]。 - past_key_values (
~cache_utils.Cache，可选) — 预计算的隐藏状态，可用于加速顺序解码。通常由模型在解码的先前阶段返回，且use_cache=True或config.use_cache=True。仅允许 Cache 实例作为输入，请参阅我们的 kv 缓存指南。如果未传递
past_key_values，默认将初始化 DynamicCache。模型将输出与输入时相同格式的缓存。
如果使用了
past_key_values，用户只需输入未处理的input_ids（即那些尚未提供给此模型的历史键值状态的标记），其形状应为(batch_size, unprocessed_length)，而非所有形状为(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）。
返回
TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 TokenClassifierOutput 或 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含取决于配置 (None) 和输入的各种元素。
The GenericForTokenClassification forward method, overrides the __call__ special method.
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失。logits (形状为
(batch_size, sequence_length, config.num_labels)的torch.FloatTensor) — 分类分数（SoftMax 之前）。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 后的注意力权重，用于计算自注意力头中的加权平均值。
MinistralForQuestionAnswering
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 start_positions: torch.LongTensor | None = None end_positions: torch.LongTensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 输入序列标记在词汇表中的索引。默认情况下，填充将被忽略。索引可以使用 AutoTokenizer 获取。详细信息请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- 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]。 - past_key_values (
~cache_utils.Cache，可选) — 预计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），可用于加速序列解码。当use_cache=True或config.use_cache=True时，这通常由模型在前一个解码阶段返回的past_key_values组成。输入仅允许使用 Cache 实例，请参阅我们的 kv 缓存指南。如果未传入
past_key_values，则默认初始化 DynamicCache。模型将输出与输入时相同格式的缓存。
如果使用了
past_key_values，用户只需输入未处理的input_ids（即那些未将其过去键值状态提供给此模型的输入），其形状为(batch_size, unprocessed_length)，而无需输入所有形状为(batch_size, sequence_length)的input_ids。 - inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 作为替代，你可以选择直接传入嵌入表示，而不是传入input_ids。如果你想比模型内部的嵌入查找矩阵更精确地控制如何将input_ids索引转换为关联向量，这将非常有用。 - start_positions (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算词元分类损失的标记跨度起始位置（索引）标签。位置被截断至序列长度 (sequence_length)。序列之外的位置不会被计入损失计算。 - end_positions (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算词元分类损失的标记跨度结束位置（索引）标签。位置被截断至序列长度 (sequence_length)。序列之外的位置不会被计入损失计算。
返回
QuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)
一个 QuestionAnsweringModelOutput 或 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False），包含取决于配置 (None) 和输入的各种元素。
The GenericForQuestionAnswering forward method, overrides the __call__ special method.
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
loss (
torch.FloatTensorof shape(1,), 可选, 当提供labels时返回) — 总范围提取损失是起始位置和结束位置的交叉熵之和。start_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 范围起始分数（SoftMax 之前）。end_logits (
torch.FloatTensorof shape(batch_size, sequence_length)) — 范围结束分数（SoftMax 之前）。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 后的注意力权重，用于计算自注意力头中的加权平均值。