Mistral
概述
Mistral 在 Albert Jiang、Alexandre Sablayrolles、Arthur Mensch、Chris Bamford、Devendra Singh Chaplot、Diego de las Casas、Florian Bressand、Gianna Lengyel、Guillaume Lample、Lélio Renard Lavaud、Lucile Saulnier、Marie-Anne Lachaux、Pierre Stock、Teven Le Scao、Thibaut Lavril、Thomas Wang、Timothée Lacroix、William El Sayed 的 这篇博文 中被介绍。
博文介绍部分写道
Mistral AI 团队很自豪地发布 Mistral 7B，它是迄今为止同尺寸最强大的语言模型。
Mistral-7B 是由 mistral.ai 发布的首个大型语言模型 (LLM)。
架构细节
Mistral-7B 是一个仅解码器的 Transformer，具有以下架构选择
- 滑动窗口注意力 - 使用 8k 上下文长度和固定缓存大小训练，理论注意力跨度为 128K 个令牌
- GQA（分组查询注意力） - 允许更快的推理和更小的缓存大小。
- 字节回退 BPE 分词器 - 确保字符永远不会映射到词汇表外的令牌。
有关更多详细信息，请参阅 发布博文。
许可证
Mistral-7B 在 Apache 2.0 许可证下发布。
使用技巧
Mistral 团队发布了 3 个检查点
- 基础模型，Mistral-7B-v0.1，它已预先训练以在互联网规模的数据上预测下一个令牌。
- 指令微调模型，Mistral-7B-Instruct-v0.1，它是使用监督微调 (SFT) 和直接偏好优化 (DPO) 为聊天目的优化的基础模型。
- 改进的指令微调模型，Mistral-7B-Instruct-v0.2，它在 v1 的基础上进行了改进。
基础模型可以使用如下方式
>>> from transformers import AutoModelForCausalLM, AutoTokenizer
>>> model = AutoModelForCausalLM.from_pretrained("mistralai/Mistral-7B-v0.1", device_map="auto")
>>> tokenizer = AutoTokenizer.from_pretrained("mistralai/Mistral-7B-v0.1")
>>> prompt = "My favourite condiment is"
>>> model_inputs = tokenizer([prompt], return_tensors="pt").to("cuda")
>>> model.to(device)
>>> generated_ids = model.generate(**model_inputs, max_new_tokens=100, do_sample=True)
>>> tokenizer.batch_decode(generated_ids)[0]
"My favourite condiment is to ..."指令微调模型可以使用如下方式
>>> from transformers import AutoModelForCausalLM, AutoTokenizer
>>> model = AutoModelForCausalLM.from_pretrained("mistralai/Mistral-7B-Instruct-v0.2", device_map="auto")
>>> tokenizer = AutoTokenizer.from_pretrained("mistralai/Mistral-7B-Instruct-v0.2")
>>> 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("cuda")
>>> 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: (...)"如您所见，指令微调模型需要应用 聊天模板 以确保输入以正确的格式准备。
使用 Flash Attention 加速 Mistral
上面的代码片段展示了没有任何优化技巧的推理。但是，可以通过利用 Flash Attention 来大幅提高模型速度，Flash Attention 是模型内部使用的注意力机制的更快实现。
首先，确保安装最新版本的 Flash Attention 2 以包含滑动窗口注意力功能。
pip install -U flash-attn --no-build-isolation
还要确保您拥有与 Flash Attention 2 兼容的硬件。在 flash attention 存储库 的官方文档中了解更多信息。还要确保以半精度 (例如 torch.float16) 加载您的模型
要使用 Flash Attention-2 加载和运行模型，请参考下面的代码片段
>>> import torch
>>> from transformers import AutoModelForCausalLM, AutoTokenizer
>>> model = AutoModelForCausalLM.from_pretrained("mistralai/Mistral-7B-v0.1", torch_dtype=torch.float16, attn_implementation="flash_attention_2", device_map="auto")
>>> tokenizer = AutoTokenizer.from_pretrained("mistralai/Mistral-7B-v0.1")
>>> prompt = "My favourite condiment is"
>>> model_inputs = tokenizer([prompt], return_tensors="pt").to("cuda")
>>> model.to(device)
>>> generated_ids = model.generate(**model_inputs, max_new_tokens=100, do_sample=True)
>>> tokenizer.batch_decode(generated_ids)[0]
"My favourite condiment is to (...)"预期加速
下面是一个预期加速图，它比较了使用 mistralai/Mistral-7B-v0.1 检查点的 transformers 中的原生实现与模型的 Flash Attention 2 版本之间的纯推理时间。
滑动窗口注意力
当前实现支持滑动窗口注意力机制和内存高效的缓存管理。要启用滑动窗口注意力，只需确保拥有与滑动窗口注意力 (>=2.3.0) 兼容的 flash-attn 版本。
Flash Attention-2 模型还使用更内存高效的缓存切片机制 - 按照使用滚动缓存机制的 Mistral 模型的官方实现建议，我们保持缓存大小固定 (self.config.sliding_window)，仅支持 padding_side="left" 的批量生成，并使用当前令牌的绝对位置来计算位置嵌入。
使用量化缩小 Mistral
由于 Mistral 模型具有 70 亿个参数，因此以半精度 (float16) 存储大约需要 14GB 的 GPU RAM，因为每个参数存储在 2 个字节中。但是，可以使用 量化 来缩小模型的大小。如果模型被量化到 4 位 (或每个参数半个字节)，则仅需要大约 3.5GB 的 RAM。
量化模型就像向模型传递一个 quantization_config 一样简单。下面，我们将利用 BitsAndyBytes 量化 (但请参考 此页面 以获取其他量化方法)
>>> import torch
>>> from transformers import AutoModelForCausalLM, AutoTokenizer, BitsAndBytesConfig
>>> # specify how to quantize the model
>>> quantization_config = BitsAndBytesConfig(
... load_in_4bit=True,
... bnb_4bit_quant_type="nf4",
... bnb_4bit_compute_dtype="torch.float16",
... )
>>> model = AutoModelForCausalLM.from_pretrained("mistralai/Mistral-7B-Instruct-v0.2", quantization_config=True, device_map="auto")
>>> tokenizer = AutoTokenizer.from_pretrained("mistralai/Mistral-7B-Instruct-v0.2")
>>> prompt = "My favourite condiment is"
>>> 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("cuda")
>>> generated_ids = model.generate(model_inputs, max_new_tokens=100, do_sample=True)
>>> tokenizer.batch_decode(generated_ids)[0]
"The expected output"此模型由 Younes Belkada 和 Arthur Zucker 贡献。原始代码可以在 这里 找到。
资源
这份文档列举了一些 Hugging Face 官方和社区（🌎标记）资源，可以帮助您开始使用 Mistral。如果您想提交一个资源到这份文档，请随意发起一个 Pull Request，我们会审核它！该资源应理想地展示一些新内容，而不是重复现有资源。
- 一个用于对 Mistral-7B 进行监督微调 (SFT) 的演示笔记本可以在这里找到：这里。🌎
- 一篇关于如何使用 Hugging Face 工具在 2024 年微调 LLM 的博文。🌎
- Hugging Face 的对齐手册包含用于执行监督微调 (SFT) 和直接偏好优化的脚本和配方，使用 Mistral-7B。这包括用于完整微调、单个 GPU 上的 QLoRa 以及多 GPU 微调的脚本。
- 因果语言建模任务指南
MistralConfig
class transformers.MistralConfig
< 源代码 >( vocab_size = 32000 hidden_size = 4096 intermediate_size = 14336 num_hidden_layers = 32 num_attention_heads = 32 num_key_value_heads = 8 head_dim = None hidden_act = 'silu' max_position_embeddings = 131072 initializer_range = 0.02 rms_norm_eps = 1e-06 use_cache = True pad_token_id = None bos_token_id = 1 eos_token_id = 2 tie_word_embeddings = False rope_theta = 10000.0 sliding_window = 4096 attention_dropout = 0.0 **kwargs )
参数
- vocab_size (
int, 可选, 默认值为 32000) — Mistral 模型的词汇量。定义了调用 MistralModel 时可以由inputs_ids表示的不同令牌数量。 - 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) — 用于实现分组查询注意力的 key_value 头的数量。如果num_key_value_heads=num_attention_heads，模型将使用多头注意力 (MHA)，如果num_key_value_heads=1模型将使用多查询注意力 (MQA)，否则将使用 GQA。在将多头检查点转换为 GQA 检查点时，每个组键和值头应通过对该组中所有原始头的平均池化来构建。有关更多详细信息，请查看 这篇论文。如果未指定，将默认为8。 - head_dim (
int, 可选, 默认值为hidden_size // num_attention_heads) — 注意力头维度。 - hidden_act (
str或function, 可选, 默认值为"silu") — 解码器中的非线性激活函数 (函数或字符串)。 - max_position_embeddings (
int, 可选, 默认值为4096*32) — 该模型可能使用的最大序列长度。 Mistral 的滑动窗口注意力允许序列最多包含 4096*32 个令牌。 - initializer_range (
float, 可选, 默认值为 0.02) — 初始化所有权重矩阵的截断正态初始化器的标准差。 - rms_norm_eps (
float, 可选, 默认值为 1e-06) — rms 归一化层使用的 epsilon。 - use_cache (
bool, 可选, 默认值为True) — 模型是否应该返回最后一个键/值注意力 (并非所有模型都使用)。仅当config.is_decoder=True时才相关。 - pad_token_id (
int, 可选) — 填充令牌的 ID。 - bos_token_id (
int, 可选, 默认值为 1) — “序列开始”令牌的 ID。 - eos_token_id (
int, 可选, 默认值为 2) — “序列结束”令牌的 ID。 - sliding_window (
int, 可选, 默认值为 4096) — 滑动窗口注意力窗口大小。如果未指定，将默认设置为4096。 - attention_dropout (
float, 可选, 默认值为 0.0) — 注意力概率的 dropout 比例。
这是一个配置类，用于存储 MistralModel 的配置。它用于根据指定的参数实例化一个 Mistral 模型，定义模型架构。使用默认值实例化配置将产生类似于 Mistral-7B-v0.1 或 Mistral-7B-Instruct-v0.1 的配置。
mistralai/Mistral-7B-v0.1 mistralai/Mistral-7B-Instruct-v0.1
配置对象继承自 PretrainedConfig，可用于控制模型输出。阅读 PretrainedConfig 的文档以获取更多信息。
>>> from transformers import MistralModel, MistralConfig
>>> # Initializing a Mistral 7B style configuration
>>> configuration = MistralConfig()
>>> # Initializing a model from the Mistral 7B style configuration
>>> model = MistralModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configMistralModel
class transformers.MistralModel
< 源代码 >( config: MistralConfig )
参数
- config (MistralConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。config — MistralConfig
不带任何特定头的 Mistral 模型，只输出原始隐藏状态。该模型继承自 PreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头等）。
该模型也是一个 PyTorch torch.nn.Module 子类。将其用作普通的 PyTorch 模块，并参考 PyTorch 文档了解与一般用法和行为相关的所有事项。
由 config.num_hidden_layers 层组成的 Transformer 解码器。每一层都是一个 MistralDecoderLayer
正向传播
< 源代码 >( 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()。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在[0, 1]中：- 1 表示未屏蔽的标记，
- 0 表示屏蔽的标记。
可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用
past_key_values，可以选择仅输入最后一个decoder_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]范围内。 - 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，用户可以选择仅输入形状为(batch_size, 1)的最后一个input_ids（那些没有向该模型提供其过去键值状态的那些），而不是所有形状为(batch_size, sequence_length)的input_ids。 - 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 MistralModel 正向方法重写了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数内定义，但您应该随后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者则静默地忽略它们。
MistralForCausalLM
正向传播
< 源代码 >( input_ids: LongTensor = None attention_mask: Optional = None position_ids: Optional = None past_key_values: Union = 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.CausalLMOutputWithPast or 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 代表掩码的词元。
可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用
past_key_values，则可以选择仅输入最后一个decoder_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]范围内选择。 - 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))，每个元组具有两个形状为(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 而不是一个简单的元组。参数 — labels (
torch.LongTensor形状为(batch_size, sequence_length)，可选)：用于计算掩码语言建模损失的标签。索引应为[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，并且仅为该标记计算它们可以节省内存，对于长序列或大型词汇量来说，这会非常显著。
返回
transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithPast 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置 (MistralConfig) 和输入的各种元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，在提供labels时返回) — 语言建模损失（用于下一个标记预测）。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前每个词汇标记的分数）。 -
past_key_values (
tuple(tuple(torch.FloatTensor)), 可选，在传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的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 之后的注意力权重，用于计算自注意力头中的加权平均值。
The MistralForCausalLM 正向方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数内定义，但您应该随后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者则静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, MistralForCausalLM
>>> model = MistralForCausalLM.from_pretrained("mistralai/Mistral-7B-v0.1")
>>> tokenizer = AutoTokenizer.from_pretrained("mistralai/Mistral-7B-v0.1")
>>> 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."MistralForSequenceClassification
class transformers.MistralForSequenceClassification
< 源代码 >( config )
参数
- config (MistralConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
带有序列分类头的 Mistral 模型 Transformer（线性层）。
MistralForSequenceClassification 使用最后一个标记来进行分类，就像其他因果模型（例如 GPT-2）一样。
由于它对最后一个标记进行分类，因此需要知道最后一个标记的位置。如果在配置中定义了 pad_token_id，它会找到每行中不是填充标记的最后一个标记。如果未定义 pad_token_id，它只会简单地获取批次中每行的最后一个值。由于在传递 inputs_embeds 而不是 input_ids 时无法猜测填充标记，因此它执行相同的操作（获取批次中每行的最后一个值）。
该模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、裁剪头等）。
该模型也是一个 PyTorch torch.nn.Module 子类。将其用作普通的 PyTorch 模块，并参考 PyTorch 文档了解与一般用法和行为相关的所有事项。
正向传播
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None position_ids: Optional = None past_key_values: Union = 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 )
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 输入序列 token 在词汇表中的索引。默认情况下会忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 。
- attention_mask (
torch.Tensor形状为(batch_size, sequence_length)，可选) — 避免在填充 token 索引上执行注意的掩码。掩码值选择在[0, 1]中：- 1 表示未掩码的 token，
- 0 表示掩码的 token。
可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 。
如果您想使用
past_key_values，则可以选择仅输入最后一个decoder_input_ids（那些没有为此模型提供 past key value 状态的decoder_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)，可选) — 每个输入序列 token 在位置嵌入中的位置索引。选择范围在[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，则用户可以选择仅输入形状为(batch_size, 1)的最后一个input_ids（那些没有为此模型提供 past key value 状态的input_ids），而不是所有形状为(batch_size, sequence_length)的input_ids。 - 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 而不是一个简单的元组。 - labels (
torch.LongTensor形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]中。如果config.num_labels == 1，则计算回归损失（均方损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。
The MistralForSequenceClassification forward method, overrides the __call__ special method.
虽然正向传递的配方需要在此函数内定义，但您应该随后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者则静默地忽略它们。
MistralForTokenClassification
class transformers.MistralForTokenClassification
< source >( config )
参数
- config (MistralConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法加载模型权重。
The Mistral Model transformer with a token classification head on top (a linear layer on top of the hidden-states output) e.g. for Named-Entity-Recognition (NER) tasks.
该模型继承自 PreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、裁剪头等）。
该模型也是一个 PyTorch torch.nn.Module 子类。将其用作普通的 PyTorch 模块，并参考 PyTorch 文档了解与一般用法和行为相关的所有事项。
正向传播
< source >( input_ids: Optional = 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 )
参数
- 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 表示被掩码的标记。
可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用
past_key_values，可以选择仅输入最后一个decoder_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]范围内选择。 - 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))，每个元组有两个形状为(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 而不是一个简单的元组。
FlaxMistralModel
class transformers.FlaxMistralModel
< source >( config: MistralConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config (MistralConfig) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
- dtype (
jax.numpy.dtype, 可选，默认值为jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32、jax.numpy.float16或jax.numpy.bfloat16之一。这可用于在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定，所有计算都将使用给定的
dtype执行。请注意，这仅指定计算的 dtype，不会影响模型参数的 dtype。
基本的 Mistral 模型转换器，输出原始隐藏状态，没有任何特定的头部。
此模型继承自 FlaxPreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是一个 Flax Linen flax.nn.Module 子类。将其用作常规的 Flax 模块，并参考 Flax 文档以了解所有与一般用法和行为相关的事项。
最后，此模型支持 JAX 的固有特性，例如
__call__
< source >( input_ids attention_mask = None position_ids = None params: dict = None past_key_values: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
numpy.ndarray形状为(batch_size, input_ids_length)) — 输入序列标记在词汇表中的索引。如果您提供填充，默认情况下会忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
numpy.ndarray形状为(batch_size, sequence_length), 可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示未掩码的标记
- 0 表示掩码的标记
可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用
past_key_values，可以选择仅输入最后一个decoder_input_ids（请参阅past_key_values）。如果您想更改填充行为，您应该阅读
modeling_opt._prepare_decoder_attention_mask并根据您的需要进行修改。有关默认策略的更多信息，请参阅 论文 中的图表 1。- 1 表示头部未掩码
- 0 表示头部掩码
- position_ids (
numpy.ndarray形状为(batch_size, sequence_length), 可选) — 输入序列标记在位置嵌入中的位置索引。在[0, config.n_positions - 1]范围内选择。 - past_key_values (
Dict[str, np.ndarray], 可选, 由init_cache返回或在传递先前的past_key_values时返回) — 预先计算的隐藏状态字典（注意力块中的键和值），可用于快速自回归解码。预先计算的键和值隐藏状态的形状为 [batch_size, max_length]。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。
返回
transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包括取决于配置 (MistralConfig) 和输入的不同元素。
-
last_hidden_state (
jnp.ndarray形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出处的隐藏状态序列。 -
past_key_values (
Dict[str, jnp.ndarray]) — 预先计算的隐藏状态字典（注意力块中的键和值），可用于快速自回归解码。预先计算的键和值隐藏状态的形状为 [batch_size, max_length]。 -
hidden_states (
tuple(jnp.ndarray), 可选, 当传递了output_hidden_states=True或当config.output_hidden_states=True时返回) —jnp.ndarray元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), 可选, 当传递了output_attentions=True或当config.output_attentions=True时返回) —jnp.ndarray元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 SoftMax 之后的注意力权重，用于计算自注意力头中的加权平均值。
FlaxMistralPreTrainedModel 的 forward 方法覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数内定义，但您应该随后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者则静默地忽略它们。
此示例使用随机模型，因为真正的模型都非常大。为了获得正确的结果，您应该使用 mistralai/Mistral-7B-v0.1 而不是 ksmcg/Mistral-tiny。如果您在加载该检查点时出现内存不足，可以在 from_pretrained 调用中添加 device_map="auto"。
示例
>>> from transformers import AutoTokenizer, FlaxMistralModel
>>> tokenizer = AutoTokenizer.from_pretrained("ksmcg/Mistral-tiny")
>>> model = FlaxMistralModel.from_pretrained("ksmcg/Mistral-tiny")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateFlaxMistralForCausalLM
class transformers.FlaxMistralForCausalLM
< 源代码 >( config: MistralConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True **kwargs )
参数
- config (MistralConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以
- dtype (
jax.numpy.dtype, 可选, 默认值jax.numpy.float32) — 计算的数据类型。可以是jax.numpy.float32、jax.numpy.float16或jax.numpy.bfloat16之一。这可以用来在 GPU 或 TPU 上启用混合精度训练或半精度推理。如果指定，所有计算将使用给定的
dtype执行。注意，这仅指定计算的 dtype，不影响模型参数的 dtype。
带有语言建模头（线性层）的 Mistral 模型变换器。
此模型继承自 FlaxPreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是一个 Flax Linen flax.nn.Module 子类。将其用作常规的 Flax 模块，并参考 Flax 文档以了解所有与一般用法和行为相关的事项。
最后，此模型支持 JAX 的固有特性，例如
__call__
< 源代码 >( input_ids attention_mask = None position_ids = None params: dict = None past_key_values: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) → transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
numpy.ndarray形状为(batch_size, input_ids_length)) — 词汇表中输入序列标记的索引。默认情况下，如果提供填充，它将被忽略。索引可以使用 AutoTokenizer 获取。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
numpy.ndarray形状为(batch_size, sequence_length), 可选) — 掩码以避免在填充标记索引上执行注意力。在[0, 1]中选择掩码值：- 1 表示未屏蔽的标记，
- 0 表示屏蔽的标记。
索引可以使用 AutoTokenizer 获取。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用
past_key_values，则可以选择仅输入最后一个decoder_input_ids（参见past_key_values）。如果您想更改填充行为，您应该阅读
modeling_opt._prepare_decoder_attention_mask并根据您的需要进行修改。有关默认策略的更多信息，请参见 论文 中的图 1。- 1 表示头部未屏蔽，
- 0 表示头部屏蔽。
- position_ids (
numpy.ndarray形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列标记位置的索引。在[0, config.n_positions - 1]范围内选择。 - past_key_values (
Dict[str, np.ndarray], 可选, 由init_cache返回，或在传递先前past_key_values时返回) — 预先计算的隐藏状态字典（注意力块中的键和值），可用于快速自回归解码。预先计算的键和值隐藏状态的形状为 [batch_size, max_length]。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量中的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量中的hidden_states。 - return_dict (
bool, 可选) — 是否返回一个 ModelOutput 而不是一个简单的元组。
返回
transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
一个 transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或者一个包含各种元素的 torch.FloatTensor 元组（如果传递了 return_dict=False 或者当 config.return_dict=False 时），这些元素取决于配置 (MistralConfig) 和输入。
-
logits (
jnp.ndarray形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇表标记的分数）。 -
hidden_states (
tuple(jnp.ndarray), 可选, 当传递了output_hidden_states=True或当config.output_hidden_states=True时返回) —jnp.ndarray元组（一个用于嵌入的输出 + 一个用于每一层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每一层输出处的隐藏状态加上初始嵌入输出。
-
attentions (
tuple(jnp.ndarray), 可选, 当传递了output_attentions=True或当config.output_attentions=True时返回) —jnp.ndarray元组（每一层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 SoftMax 之后的注意力权重，用于计算自注意力头中的加权平均值。
-
cross_attentions (
tuple(jnp.ndarray), 可选, 当传递output_attentions=True或者当config.output_attentions=True时返回) —jnp.ndarray元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 SoftMax 之后的交叉注意力权重，用于计算交叉注意力头的加权平均值。
-
past_key_values (
tuple(tuple(jnp.ndarray)), 可选, 当传递use_cache=True或者当config.use_cache=True时返回) — 长度为config.n_layers的jnp.ndarray元组，每个元组包含自注意力和交叉注意力层的缓存键、值状态，如果模型用于编码器-解码器设置。仅当config.is_decoder = True时相关。包含预先计算的隐藏状态（注意力块中的键和值），可以用来（参见
past_key_values输入）加速顺序解码。
FlaxMistralPreTrainedModel 的 forward 方法覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数内定义，但您应该随后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者则静默地忽略它们。
此示例使用随机模型，因为真正的模型都非常大。为了获得正确的结果，您应该使用 mistralai/Mistral-7B-v0.1 而不是 ksmcg/Mistral-tiny。如果您在加载该检查点时出现内存不足，可以在 from_pretrained 调用中添加 device_map="auto"。
示例
>>> from transformers import AutoTokenizer, FlaxMistralForCausalLM
>>> tokenizer = AutoTokenizer.from_pretrained("ksmcg/Mistral-tiny")
>>> model = FlaxMistralForCausalLM.from_pretrained("ksmcg/Mistral-tiny")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="np")
>>> outputs = model(**inputs)
>>> # retrieve logts for next token
>>> next_token_logits = outputs.logits[:, -1]TFMistralModel
class transformers.TFMistralModel
< source >( config: MistralConfig *inputs **kwargs )
参数
- config (MistralConfig) — 模型配置类，包含模型的所有参数。用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
基础 Mistral 模型，输出原始隐藏状态，没有任何特定的头部。
此模型继承自 TFPreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是一个 keras.Model 子类。将其用作常规 TF 2.0 Keras 模型，并参考 TF 2.0 文档以了解有关一般用法和行为的所有事项。
model 中的 TensorFlow 模型和层接受两种格式作为输入
- 将所有输入作为关键字参数（类似 PyTorch 模型），或者
- 将所有输入作为第一个位置参数的列表、元组或字典。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于支持这种格式，在使用像 model.fit() 这样的方法时，事情应该“按预期工作”——只需以 model.fit() 支持的任何格式传递您的输入和标签即可！但是，如果您想在像 fit() 和 predict() 这样的 Keras 方法之外使用第二种格式，例如在使用 Keras Functional API 创建您自己的层或模型时，您可以使用三种方法来收集第一个位置参数中的所有输入张量
- 仅包含
input_ids的单个张量，以及其他任何内容：model(input_ids) - 长度可变的列表，包含一个或多个输入张量，以文档字符串中给出的顺序排列：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 包含一个或多个输入张量，以及与文档字符串中给出的输入名称关联的字典：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，在使用 子类化 创建模型和层时，您无需担心这些问题，因为您可以像对任何其他 Python 函数一样传递输入！
call
< source >( input_ids: Tensor = None attention_mask: Optional = None position_ids: Optional = None past_key_values: Optional = None inputs_embeds: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None )
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 输入序列标记在词汇表中的索引。如果您提供填充，默认情况下将忽略填充。可以使用 AutoTokenizer 获取索引。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详细信息。
- attention_mask (
tf.Tensor形状为(batch_size, sequence_length), 可选) — 用于避免在填充 token 索引上执行注意力的掩码。在[0, 1]中选择掩码值：- 1 表示**未屏蔽**的 token，
- 0 表示**屏蔽**的 token。
可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用
past_key_values，可以选择仅输入最后一个decoder_input_ids（请参阅past_key_values）。如果您想更改填充行为，您应该阅读
modeling_opt._prepare_decoder_attention_mask并根据您的需要进行修改。有关默认策略的更多信息，请参阅论文 中的图 1。- 1 表示头部**未屏蔽**，
- 0 表示头部**屏蔽**。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列 token 位置的索引。在[0, config.n_positions - 1]范围内选择。 - past_key_values (
Cache或tuple(tuple(tf.Tensor)), 可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在解码的先前阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许一种格式：
- 长度为
config.n_layers的tuple(tuple(tf.Tensor))元组，每个元组都有 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 (
tf.Tensor形状为(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 而不是普通元组。
该 TFMistralModel 正向方法覆盖 __call__ 特殊方法。
虽然正向传递的配方需要在此函数内定义，但您应该随后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者则静默地忽略它们。
TFMistralForCausalLM
call
< 源代码 >( input_ids: Tensor = 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 )
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。如果您提供填充，默认情况下将忽略填充。索引可以使用 AutoTokenizer 获取。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
tf.Tensor形状为(batch_size, sequence_length)，可选) — 掩码以避免对填充标记索引执行注意力。在[0, 1]中选择掩码值：- 1 用于未屏蔽的标记，
- 0 用于屏蔽的标记。
索引可以使用 AutoTokenizer 获取。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用
past_key_values，可选地只需输入最后一个decoder_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]。 - past_key_values (
Cache或tuple(tuple(tf.Tensor))，可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在解码的先前阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许一种格式：
tuple(tf.Tensor)长度为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 (
tf.Tensor形状为(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 而不是普通元组。参数 — labels (
tf.Tensorof shape(batch_size, sequence_length), 可选): 用于计算掩码语言建模损失的标签。索引应在[0, ..., config.vocab_size]或 -100 中（参见input_ids文档字符串）。索引设置为-100的令牌将被忽略（屏蔽），仅计算标签在[0, ..., config.vocab_size]中的令牌的损失。
该 TFMistralForCausalLM 正向方法覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数内定义，但您应该随后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者则静默地忽略它们。
TFMistralForSequenceClassification
class transformers.TFMistralForSequenceClassification
< 源代码 >( config *inputs **kwargs )
参数
- config (MistralConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
带有序列分类头的 Mistral 模型 Transformer（线性层）。
MistralForSequenceClassification 使用最后一个标记来进行分类，就像其他因果模型（例如 GPT-2）一样。
由于它对最后一个标记进行分类，因此需要知道最后一个标记的位置。如果在配置中定义了 pad_token_id，它会找到每行中不是填充标记的最后一个标记。如果未定义 pad_token_id，它只会简单地获取批次中每行的最后一个值。由于在传递 inputs_embeds 而不是 input_ids 时无法猜测填充标记，因此它执行相同的操作（获取批次中每行的最后一个值）。
此模型继承自 TFPreTrainedModel。查看超类文档以了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是一个 keras.Model 子类。将其用作常规 TF 2.0 Keras 模型，并参考 TF 2.0 文档以了解有关一般用法和行为的所有事项。
model 中的 TensorFlow 模型和层接受两种格式作为输入
- 将所有输入作为关键字参数（类似 PyTorch 模型），或者
- 将所有输入作为第一个位置参数的列表、元组或字典。
支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于支持这种格式，在使用像 model.fit() 这样的方法时，事情应该“按预期工作”——只需以 model.fit() 支持的任何格式传递您的输入和标签即可！但是，如果您想在像 fit() 和 predict() 这样的 Keras 方法之外使用第二种格式，例如在使用 Keras Functional API 创建您自己的层或模型时，您可以使用三种方法来收集第一个位置参数中的所有输入张量
- 仅包含
input_ids的单个张量，以及其他任何内容：model(input_ids) - 长度可变的列表，包含一个或多个输入张量，以文档字符串中给出的顺序排列：
model([input_ids, attention_mask])或model([input_ids, attention_mask, token_type_ids]) - 包含一个或多个输入张量，以及与文档字符串中给出的输入名称关联的字典：
model({"input_ids": input_ids, "token_type_ids": token_type_ids})
请注意，在使用 子类化 创建模型和层时，您无需担心这些问题，因为您可以像对任何其他 Python 函数一样传递输入！
call
< 源代码 >( input_ids: Tensor = 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 )
参数
- input_ids (
torch.LongTensorof shape(batch_size, sequence_length)) — 输入序列令牌在词汇表中的索引。如果您提供填充，默认情况下将忽略填充。索引可以使用 AutoTokenizer 获取。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (
tf.Tensor形状为(batch_size, sequence_length)，可选) — 用于避免对填充 token 索引执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示未掩码的 token，
- 0 表示掩码的 token。
可以使用 AutoTokenizer 获取索引。有关详细信息，请参见 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用
past_key_values，则可以选择仅输入最后一个decoder_input_ids（参见past_key_values）。如果你想更改填充行为，你应该阅读
modeling_opt._prepare_decoder_attention_mask并修改为你的需求。有关默认策略的更多信息，请参见 论文 中的图 1。- 1 表示头部未掩码，
- 0 表示头部掩码。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 位置嵌入中每个输入序列 token 的位置索引。在[0, config.n_positions - 1]范围内选择。 - past_key_values (
Cache或tuple(tuple(tf.Tensor))，可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在解码的先前阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许一种格式：
- 长度为
config.n_layers的tuple(tf.Tensor)元组，每个元组包含 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 (
tf.Tensor形状为(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 而不是一个简单的元组。参数 — labels (
tf.Tensor形状为(batch_size, sequence_length)，可选): 用于计算掩码语言建模损失的标签。索引应在[0, ..., config.vocab_size]或 -100 中（参见input_ids文档字符串）。索引设置为-100的 token 将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]中的 token 计算。
The TFMistralForSequenceClassification forward method, overrides the __call__ special method.
虽然正向传递的配方需要在此函数内定义，但您应该随后调用 Module 实例，而不是调用此函数，因为前者负责运行预处理和后处理步骤，而后者则静默地忽略它们。