Transformers 文档
ModernVBert
并获得增强的文档体验
开始使用
该模型于 2025 年 10 月 1 日发布在 HF 论文中，并于 2026 年 2 月 23 日贡献给 Hugging Face Transformers。
ModernVBert
概述
ModernVBert 是一个视觉-语言编码器，结合了 ModernBert 和 SigLIP 视觉编码器。它针对视觉文档理解和检索任务进行了优化。
该模型在 ModernVBERT: Towards Smaller Visual Document Retrievers（ModernVBERT：迈向更小的视觉文档检索器）中首次提出。
import torch
from huggingface_hub import hf_hub_download
from PIL import Image
from transformers import AutoModelForMaskedLM, AutoProcessor
processor = AutoProcessor.from_pretrained("./mvb")
model = AutoModelForMaskedLM.from_pretrained("./mvb", device_map="auto")
image = Image.open(hf_hub_download("HuggingFaceTB/SmolVLM", "example_images/rococo.jpg", repo_type="space"))
text = "This [MASK] is on the wall."
# Create input messages
messages = [
{
"role": "user",
"content": [
{"type": "image"},
{"type": "text", "text": text}
]
},
]
# Prepare inputs
prompt = processor.apply_chat_template(messages)
inputs = processor(text=prompt, images=[image], return_tensors="pt").to(model.device)
# Inference
with torch.no_grad():
outputs = model(**inputs)
# To get predictions for the mask:
masked_index = inputs["input_ids"][0].tolist().index(processor.tokenizer.mask_token_id)
predicted_token_id = outputs.logits[0, masked_index].argmax(axis=-1)
predicted_token = processor.tokenizer.decode(predicted_token_id)
print("Predicted token:", predicted_token) # Predicted token: paintingModernVBertConfig
class transformers.ModernVBertConfig
< 源代码 >( 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 text_config: transformers.configuration_utils.PreTrainedConfig | dict | None = None vision_config: transformers.configuration_utils.PreTrainedConfig | dict | None = None image_token_id: int = 50407 pixel_shuffle_factor: int = 4 initializer_range: float = 0.02 initializer_cutoff_factor: float = 2.0 classifier_pooling: typing.Literal['cls', 'mean'] = 'cls' classifier_dropout: float | int = 0.0 classifier_bias: bool = False tie_word_embeddings: bool = False )
参数
- text_config (
Union[~configuration_utils.PreTrainedConfig, dict], 可选) — 文本骨干网络的配置对象或字典。 - vision_config (
Union[~configuration_utils.PreTrainedConfig, dict], 可选) — 视觉骨干网络的配置对象或字典。 - image_token_id (
int, 可选, 默认为50407) — 用作输入图像占位符的图像标记索引。 - pixel_shuffle_factor (
int | None, 可选, 默认为 4) — 视觉头中任何像素重排（pixel-shuffle）/上采样操作使用的缩放因子。 - initializer_range (
float, 可选, 默认为0.02) — 用于初始化所有权重矩阵的截断正态初始化器（truncated_normal_initializer）的标准差。 - initializer_cutoff_factor (
float | None, 可选, 默认为 2.0) — 用于初始化所有权重矩阵的截断正态初始化器的截止因子。 - classifier_pooling (
Literal["cls", "mean"], 可选, 默认为"cls") — 分类任务使用的池化策略。 - classifier_dropout (
Union[float, int], 可选, 默认为0.0) — 分类器的 dropout 比率。 - classifier_bias (
bool | None, 可选, 默认为False) — 是否在分类头中添加偏置项。 - tie_word_embeddings (
bool, 可选, 默认为False) — 是否根据模型的tied_weights_keys映射绑定权重嵌入。
这是用于存储 ModernVBertModel 配置的配置类。它用于根据指定的参数实例化 ModernVBert 模型，从而定义模型架构。使用默认值实例化配置将产生与 ModernVBERT/modernvbert 类似的配置。
配置对象继承自 PreTrainedConfig，可用于控制模型输出。阅读 PreTrainedConfig 的文档以获取更多信息。
示例
>>> from transformers import ModernVBertConfig
>>> # Initializing configuration
>>> configuration = ModernVBertConfig()
>>> # Initializing a model from the configuration (model class is implemented in
>>> # `modernvbert.modeling_modernvbert`)
>>> from transformers import ModernVBertModel
>>> model = ModernVBertModel(configuration)
>>> # Accessing the model configuration
>>> cfg = model.configModernVBertModel
class transformers.ModernVBertModel
< 源代码 >( config: ModernVBertConfig )
参数
- config (ModernVBertConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化模型不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
ModernVBertModel 是一个结合了视觉编码器 (SigLIP) 和文本编码器 (ModernBert) 的模型。
ModernVBert 是视觉检索器 ColModernVBert 的基础模型，在以下论文中首次提出：ModernVBERT: Towards Smaller Visual Document Retrievers（ModernVBERT：迈向更小的视觉文档检索器）。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源代码 >( input_ids: LongTensor = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None inputs_embeds: torch.FloatTensor | None = None pixel_values: torch.FloatTensor | None = None pixel_attention_mask: torch.BoolTensor | None = None image_hidden_states: torch.FloatTensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → ModernVBertBaseModelOutput 或 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]范围内选择。 - inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size), 可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你想比模型内部的嵌入查找矩阵更好地控制如何将input_ids索引转换为关联向量，这非常有用。 - pixel_values (
torch.FloatTensor，形状为(batch_size, num_channels, image_size, image_size), 可选) — 与输入图像对应的张量。像素值可以使用image_processor_class获取。有关详细信息，请参阅image_processor_class.__call__（Idefics3Processor 使用image_processor_class来处理图像）。 - pixel_attention_mask (
torch.Tensor，形状为(batch_size, image_size, image_size)，可选) — 用于避免对填充（padding）像素索引执行注意力机制的掩码。 - image_hidden_states (
torch.FloatTensor，形状为(batch_size, num_channels, image_size, image_size)) — 经过模态投影后图像编码器的隐藏状态。
返回
ModernVBertBaseModelOutput 或 tuple(torch.FloatTensor)
一个 ModernVBertBaseModelOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或 config.return_dict=False 时），根据配置（ModernVBertConfig）和输入的不同，包含各种元素。
输入到模型中的图像数量可以任意。为了处理这一点，馈送到模型的 pixel_values 包含图像填充 -> (batch_size, max_num_images, 3, max_heights, max_widths)，其中 max_num_images 是批次中所有样本中图像的最大数量。填充图像仅在进入模型时需要进行 pixel_values 填充。为了提高效率，我们只将真实图像传递给 vision_model 的前向过程，即丢弃填充图像，即大小为 (image_batch_size, 3, height, width) 的 pixel_values，其中如果 num_images_per_sample=[1, 3, 1, 2]，image_batch_size 将为 7，而 max_num_images 将为 3。
- last_hidden_state (
torch.FloatTensorof shape(batch_size, sequence_length, hidden_size)) — 模型最后一层的隐藏状态序列。如果使用past_key_values，则仅输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。 - 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), optional, 当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。 - image_hidden_states (
tuple(torch.FloatTensor)，可选) —torch.FloatTensor的元组（一个用于图像嵌入的输出，(batch_size, num_images, sequence_length, hidden_size)。由视觉编码器生成的模型 image_hidden_states。
ModernVBertForMaskedLM
class transformers.ModernVBertForMaskedLM
< 源代码 >( config: ModernVBertConfig )
参数
- config (ModernVBertConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
带有语言建模头部的 ModernVBert 模型。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源代码 >( input_ids: LongTensor = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None inputs_embeds: torch.FloatTensor | None = None pixel_values: torch.FloatTensor | None = None pixel_attention_mask: torch.BoolTensor | None = None image_hidden_states: torch.FloatTensor | None = None labels: torch.LongTensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → ModernVBertMaskedLMOutput 或 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]范围。 - inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 此外，与其传递input_ids，您可以选择直接传递嵌入表示。如果您想比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联向量，这非常有用。 - pixel_values (
torch.FloatTensor，形状为(batch_size, num_channels, image_size, image_size)，可选) — 对应于输入图像的张量。像素值可以使用image_processor_class获取。详情请参见image_processor_class.__call__（Idefics3Processor 使用image_processor_class来处理图像）。 - pixel_attention_mask (
torch.Tensor，形状为(batch_size, image_size, image_size)，可选) — 用于避免对填充像素索引执行注意力机制的掩码。 - image_hidden_states (
torch.FloatTensor，形状为(batch_size, num_channels, image_size, image_size)) — 经过模态投影后图像编码器的隐藏状态。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于计算掩码语言建模损失的标签。索引应该在[0, ..., text_config.]或model.image_token_id中。索引设置为model.image_token_id的标记将被忽略（掩码），损失仅针对标签在[0, ..., text_config.]中的标记进行计算。
返回
ModernVBertMaskedLMOutput 或 tuple(torch.FloatTensor)
一个 ModernVBertMaskedLMOutput 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（ModernVBertConfig）和输入的不同，包含各种元素。
输入到模型中的图像数量可以任意。为了处理这一点，馈送到模型的 pixel_values 包含图像填充 -> (batch_size, max_num_images, 3, max_heights, max_widths)，其中 max_num_images 是批次中所有样本中图像的最大数量。填充图像仅在进入模型时需要进行 pixel_values 填充。为了提高效率，我们只将真实图像传递给 vision_model 的前向过程，即丢弃填充图像，即大小为 (image_batch_size, 3, height, width) 的 pixel_values，其中如果 num_images_per_sample=[1, 3, 1, 2]，image_batch_size 将为 7，而 max_num_images 将为 3。
- loss (
torch.FloatTensor，可选，当提供labels时返回) — 掩码语言建模（MLM）损失。 - logits (
torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。 - 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), optional, 当传递output_attentions=True或config.output_attentions=True时返回) —torch.FloatTensor的元组（每层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。 - image_hidden_states (
tuple(torch.FloatTensor)，可选) —torch.FloatTensor的元组（一个用于图像嵌入的输出，(batch_size, num_images, sequence_length, hidden_size)。由视觉编码器生成的模型 image_hidden_states。
示例
>>> from transformers import AutoTokenizer, ModernVBertForMaskedLM
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("ModernVBERT/modernvbert")
>>> model = ModernVBertForMaskedLM.from_pretrained("ModernVBERT/modernvbert")
>>> inputs = tokenizer("The capital of France is <mask>.", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> # retrieve index of <mask>
>>> mask_token_index = (inputs.input_ids == tokenizer.mask_token_id)[0].nonzero(as_tuple=True)[0]
>>> predicted_token_id = logits[0, mask_token_index].argmax(axis=-1)
>>> tokenizer.decode(predicted_token_id)
...
>>> labels = tokenizer("The capital of France is Paris.", return_tensors="pt")["input_ids"]
>>> # mask labels of non-<mask> tokens
>>> labels = torch.where(inputs.input_ids == tokenizer.mask_token_id, labels, -100)
>>> outputs = model(**inputs, labels=labels)
>>> round(outputs.loss.item(), 2)
...ModernVBertForSequenceClassification
class transformers.ModernVBertForSequenceClassification
< 源代码 >( config: ModernVBertConfig )
参数
- config (ModernVBertConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
带有执行池化（pooling）的序列分类头部的 ModernVBert 模型。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源代码 >( input_ids: LongTensor = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None inputs_embeds: torch.FloatTensor | None = None pixel_values: torch.FloatTensor | None = None pixel_attention_mask: torch.BoolTensor | None = None image_hidden_states: torch.FloatTensor | None = None labels: torch.LongTensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → SequenceClassifierOutput 或 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 (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 每个输入序列 token 在位置嵌入中的位置索引。在范围[0, config.n_positions - 1]中选择。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选) — 可选参数，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你想比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联向量，这将非常有用。 - pixel_values (形状为
(batch_size, num_channels, image_size, image_size)的torch.FloatTensor，可选) — 对应于输入图像的张量。像素值可以使用image_processor_class获取。详情请参阅image_processor_class.__call__（Idefics3Processor 使用image_processor_class处理图像）。 - pixel_attention_mask (形状为
(batch_size, image_size, image_size)的torch.Tensor，可选) — 用于避免对填充像素索引执行注意力计算的掩码。 - image_hidden_states (形状为
(batch_size, num_channels, image_size, image_size)的torch.FloatTensor) — 经过模态投影后的图像编码器隐藏状态。 - labels (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 用于计算掩码语言建模损失的标签。索引应位于[0, ..., text_config.]或model.image_token_id中。索引设置为model.image_token_id的 token 将被忽略（掩码处理），损失仅针对标签在[0, ..., text_config.]中的 token 进行计算。
返回
SequenceClassifierOutput 或 tuple(torch.FloatTensor)
一个 SequenceClassifierOutput 或一个 torch.FloatTensor 元组（如果传入了 return_dict=False 或 config.return_dict=False 时），根据配置（ModernVBertConfig）和输入，包含各种元素。
输入到模型中的图像数量可以任意。为了处理这一点，馈送到模型的 pixel_values 包含图像填充 -> (batch_size, max_num_images, 3, max_heights, max_widths)，其中 max_num_images 是批次中所有样本中图像的最大数量。填充图像仅在进入模型时需要进行 pixel_values 填充。为了提高效率，我们只将真实图像传递给 vision_model 的前向过程，即丢弃填充图像，即大小为 (image_batch_size, 3, height, width) 的 pixel_values，其中如果 num_images_per_sample=[1, 3, 1, 2]，image_batch_size 将为 7，而 max_num_images 将为 3。
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失（如果 config.num_labels==1，则为回归损失）。logits (形状为
(batch_size, config.num_labels)的torch.FloatTensor) — 分类（如果 config.num_labels==1，则为回归）分数（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 后的注意力权重，用于计算自注意力头中的加权平均值。
单标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, ModernVBertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("ModernVBERT/modernvbert")
>>> model = ModernVBertForSequenceClassification.from_pretrained("ModernVBERT/modernvbert")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
...
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = ModernVBertForSequenceClassification.from_pretrained("ModernVBERT/modernvbert", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...多标签分类示例
>>> import torch
>>> from transformers import AutoTokenizer, ModernVBertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("ModernVBERT/modernvbert")
>>> model = ModernVBertForSequenceClassification.from_pretrained("ModernVBERT/modernvbert", problem_type="multi_label_classification")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = ModernVBertForSequenceClassification.from_pretrained(
... "ModernVBERT/modernvbert", num_labels=num_labels, problem_type="multi_label_classification"
... )
>>> labels = torch.sum(
... torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).lossModernVBertForTokenClassification
class transformers.ModernVBertForTokenClassification
< 源代码 >( config: ModernVBertConfig )
参数
- config (ModernVBertConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
带有顶部 token 分类头的 ModernVBert 模型，例如用于命名实体识别 (NER) 任务。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源代码 >( input_ids: LongTensor = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None inputs_embeds: torch.FloatTensor | None = None pixel_values: torch.FloatTensor | None = None pixel_attention_mask: torch.BoolTensor | None = None image_hidden_states: torch.FloatTensor | None = None labels: torch.LongTensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) → TokenClassifierOutput 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 词汇表中输入序列 token 的索引。默认情况下，填充内容将被忽略。索引可以使用 AutoTokenizer 获取。详情请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor，可选) — 用于避免对填充 token 索引执行注意力计算的掩码。掩码值在[0, 1]中选择：- 1 表示未被掩码的 token，
- 0 表示被掩码的 token。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 每个输入序列 token 在位置嵌入中的位置索引。在范围[0, config.n_positions - 1]中选择。 - inputs_embeds (形状为
(batch_size, sequence_length, hidden_size)的torch.FloatTensor，可选) — 可选参数，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你想比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为关联向量，这将非常有用。 - pixel_values (形状为
(batch_size, num_channels, image_size, image_size)的torch.FloatTensor，可选) — 对应于输入图像的张量。像素值可以使用image_processor_class获取。详情请参阅image_processor_class.__call__（Idefics3Processor 使用image_processor_class处理图像）。 - pixel_attention_mask (形状为
(batch_size, image_size, image_size)的torch.Tensor，可选) — 用于避免对填充像素索引执行注意力计算的掩码。 - image_hidden_states (形状为
(batch_size, num_channels, image_size, image_size)的torch.FloatTensor) — 经过模态投影后的图像编码器隐藏状态。 - labels (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 用于计算掩码语言建模损失的标签。索引应位于[0, ..., text_config.]或model.image_token_id中。索引设置为model.image_token_id的 token 将被忽略（掩码处理），损失仅针对标签在[0, ..., text_config.]中的 token 进行计算。
返回
TokenClassifierOutput 或 tuple(torch.FloatTensor)
一个 TokenClassifierOutput 或一个 torch.FloatTensor 元组（如果传入了 return_dict=False 或 config.return_dict=False 时），根据配置（ModernVBertConfig）和输入，包含各种元素。
输入到模型中的图像数量可以任意。为了处理这一点，馈送到模型的 pixel_values 包含图像填充 -> (batch_size, max_num_images, 3, max_heights, max_widths)，其中 max_num_images 是批次中所有样本中图像的最大数量。填充图像仅在进入模型时需要进行 pixel_values 填充。为了提高效率，我们只将真实图像传递给 vision_model 的前向过程，即丢弃填充图像，即大小为 (image_batch_size, 3, height, width) 的 pixel_values，其中如果 num_images_per_sample=[1, 3, 1, 2]，image_batch_size 将为 7，而 max_num_images 将为 3。
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 后的注意力权重，用于计算自注意力头中的加权平均值。
示例
>>> from transformers import AutoTokenizer, ModernVBertForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("ModernVBERT/modernvbert")
>>> model = ModernVBertForTokenClassification.from_pretrained("ModernVBERT/modernvbert")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="pt"
... )
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_token_class_ids = logits.argmax(-1)
>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t.item()] for t in predicted_token_class_ids[0]]
>>> predicted_tokens_classes
...
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...