Transformers 文档

ConvNeXT

Hugging Face's logo
加入 Hugging Face 社区

并获得增强型文档体验

开始使用

ConvNeXT

概述

ConvNeXT 模型由 Zhuang Liu、Hanzi Mao、Chao-Yuan Wu、Christoph Feichtenhofer、Trevor Darrell 和 Saining Xie 在 A ConvNet for the 2020s 中提出。ConvNeXT 是一种纯卷积模型 (ConvNet),其设计灵感来自 Vision Transformers,并声称其性能优于后者。

论文中的摘要如下:

视觉识别的“咆哮的 20 年代”始于 Vision Transformers (ViT) 的引入,它迅速取代了 ConvNet 成为最先进的图像分类模型。另一方面,当应用于一般的计算机视觉任务(如目标检测和语义分割)时,普通的 ViT 会面临困难。正是分层 Transformer(例如 Swin Transformers)重新引入了几个 ConvNet 先验知识,使 Transformer 作为通用的视觉骨干网络在实践中变得可行,并在各种视觉任务上展现出卓越的性能。然而,此类混合方法的有效性在很大程度上仍然归因于 Transformer 的内在优越性,而不是卷积固有的归纳偏差。在这项工作中,我们重新审视了设计空间,并测试了纯 ConvNet 可以达到的极限。我们逐步将标准 ResNet “现代化”以适应视觉 Transformer 的设计,并在此过程中发现了几个有助于性能差异的关键组件。这项探索的结果是一系列名为 ConvNeXT 的纯 ConvNet 模型。ConvNeXT 完全由标准 ConvNet 模块构建,在准确性和可扩展性方面与 Transformer 竞争,实现了 87.8% 的 ImageNet top-1 准确率,并在 COCO 检测和 ADE20K 分割方面优于 Swin Transformer,同时保持了标准 ConvNet 的简单性和效率。

drawing ConvNeXT 架构。摘自原始论文

此模型由 nielsr 贡献。该模型的 TensorFlow 版本由 ariG23498gantesayakpaul(贡献相同)贡献。原始代码可以在这里找到 这里

资源

以下列出了官方 Hugging Face 和社区(🌎 表示)资源,可帮助您开始使用 ConvNeXT。

图像分类

如果您有兴趣提交要在此处包含的资源,请随时打开一个 Pull Request,我们会进行审查!理想情况下,该资源应展示一些新内容,而不是重复现有资源。

ConvNextConfig

class transformers.ConvNextConfig

< >

( num_channels = 3 patch_size = 4 num_stages = 4 hidden_sizes = None depths = None hidden_act = 'gelu' initializer_range = 0.02 layer_norm_eps = 1e-12 layer_scale_init_value = 1e-06 drop_path_rate = 0.0 image_size = 224 out_features = None out_indices = None **kwargs )

参数

  • num_channels (int, 可选,默认为 3) — 输入通道数。
  • patch_size (int, 可选,默认为 4) — 在 patch embedding 层中使用的 patch 大小。
  • num_stages (int, 可选,默认为 4) — 模型中的阶段数。
  • hidden_sizes (List[int], 可选,默认为 [96, 192, 384, 768]) — 每个阶段的维度(隐藏大小)。
  • depths (List[int]可选,默认为 [3, 3, 9, 3]) — 每个阶段的深度(块数)。
  • hidden_act (strfunction可选,默认为 "gelu") — 每个块中的非线性激活函数(函数或字符串)。如果为字符串,则支持 "gelu""relu""selu""gelu_new"
  • initializer_range (float可选,默认为 0.02) — 初始化所有权重矩阵的截断正态初始化器的标准差。
  • layer_norm_eps (float可选,默认为 1e-12) — 层归一化层使用的 epsilon。
  • layer_scale_init_value (float可选,默认为 1e-6) — 层缩放的初始值。
  • drop_path_rate (float可选,默认为 0.0) — 随机深度的丢弃率。
  • out_features (List[str]可选) — 如果用作骨干网络,则输出特征的列表。可以是 "stem""stage1""stage2" 等(取决于模型有多少个阶段)。如果未设置且 out_indices 已设置,则默认为相应的阶段。如果未设置且 out_indices 未设置,则默认为最后一个阶段。必须与 stage_names 属性中定义的顺序相同。
  • out_indices (List[int]可选) — 如果用作骨干网络,则输出特征的索引列表。可以是 0、1、2 等(取决于模型有多少个阶段)。如果未设置且 out_features 已设置,则默认为相应的阶段。如果未设置且 out_features 未设置,则默认为最后一个阶段。必须与 stage_names 属性中定义的顺序相同。

这是用于存储 ConvNextModel 配置的配置类。它用于根据指定的参数实例化 ConvNeXT 模型,定义模型架构。使用默认值实例化配置将产生与 ConvNeXT facebook/convnext-tiny-224 架构类似的配置。

配置对象继承自 PretrainedConfig,可用于控制模型输出。阅读 PretrainedConfig 的文档以获取更多信息。

示例

>>> from transformers import ConvNextConfig, ConvNextModel

>>> # Initializing a ConvNext convnext-tiny-224 style configuration
>>> configuration = ConvNextConfig()

>>> # Initializing a model (with random weights) from the convnext-tiny-224 style configuration
>>> model = ConvNextModel(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

ConvNext特征提取器

transformers.ConvNextFeatureExtractor

< >

( *args **kwargs )

ConvNextImageProcessor

transformers.ConvNextImageProcessor

< >

( do_resize: bool = True size: Dict = None crop_pct: float = None resample: Resampling = <Resampling.BILINEAR: 2> do_rescale: bool = True rescale_factor: Union = 0.00392156862745098 do_normalize: bool = True image_mean: Union = None image_std: Union = None **kwargs )

参数

  • do_resize (bool, 可选, 默认为 True) — 控制是否将图像的 (高度, 宽度) 尺寸调整为指定的 size。可以在 preprocess 方法中通过 do_resize 覆盖。
  • size (Dict[str, int] 可选, 默认为 {"shortest_edge" -- 384}): 应用 resize 后输出图像的分辨率。如果 size["shortest_edge"] >= 384,则图像将调整为 (size["shortest_edge"], size["shortest_edge"])。否则,图像的较小边将与 int(size["shortest_edge"]/crop_pct) 匹配,之后图像将裁剪为 (size["shortest_edge"], size["shortest_edge"])。仅当 do_resize 设置为 True 时有效。可以在 preprocess 方法中通过 size 覆盖。
  • crop_pct (float 可选, 默认为 224 / 256) — 要裁剪的图像的百分比。仅当 do_resizeTrue 且 size < 384 时有效。可以在 preprocess 方法中通过 crop_pct 覆盖。
  • resample (PILImageResampling, 可选, 默认为 Resampling.BILINEAR) — 如果调整图像大小,则要使用的重采样过滤器。可以在 preprocess 方法中通过 resample 覆盖。
  • do_rescale (bool, 可选, 默认为 True) — 是否根据指定的比例 rescale_factor 重新缩放图像。可以在 preprocess 方法中通过 do_rescale 覆盖。
  • rescale_factor (intfloat, 可选, 默认为 1/255) — 如果重新缩放图像,则要使用的缩放因子。可以在 preprocess 方法中通过 rescale_factor 覆盖。
  • do_normalize (bool, 可选, 默认为 True) — 是否标准化图像。可以通过 preprocess 方法中的 do_normalize 参数覆盖。
  • image_std (floatList[float], 可选,默认为 IMAGENET_STANDARD_STD) — 如果对图像进行标准化,则使用的标准差。这是一个浮点数或与图像通道数长度相同的浮点数列表。可以在 preprocess 方法中的 image_std 参数中覆盖。

构建一个ConvNeXT图像处理器。

preprocess

< >

( images: Union do_resize: bool = None size: Dict = None crop_pct: float = None resample: Resampling = None do_rescale: bool = None rescale_factor: float = None do_normalize: bool = None image_mean: Union = None image_std: Union = None return_tensors: Union = None data_format: ChannelDimension = <ChannelDimension.FIRST: 'channels_first'> input_data_format: Union = None )

参数

  • images (ImageInput) — 要预处理的图像。期望单个或一批像素值范围为 0 到 255 的图像。如果传入像素值介于 0 和 1 之间的图像,请设置 do_rescale=False
  • do_resize (bool, 可选,默认为 self.do_resize) — 是否调整图像大小。
  • size (Dict[str, int], 可选,默认为 self.size) — 应用 resize 后输出图像的大小。如果 size["shortest_edge"] >= 384,则图像调整为 (size["shortest_edge"], size["shortest_edge"])。否则,图像的较小边将与 int(size["shortest_edge"]/ crop_pct) 匹配,之后图像将裁剪为 (size["shortest_edge"], size["shortest_edge"])。仅当 do_resize 设置为 True 时才有效。
  • crop_pct (float, 可选,默认为 self.crop_pct) — 如果 size < 384,则要裁剪的图像的百分比。
  • resample (int, 可选,默认为 self.resample) — 如果调整图像大小,则使用的重采样滤镜。这可以是 PILImageResampling 过滤器之一。仅当 do_resize 设置为 True 时才有效。
  • do_rescale (bool, 可选,默认为 self.do_rescale) — 是否将图像值重新缩放至 [0 - 1] 之间。
  • rescale_factor (float, 可选,默认为 self.rescale_factor) — 如果 do_rescale 设置为 True,则用于重新缩放图像的重新缩放因子。

  • do_normalizebool可选,默认为 self.do_normalize)— 是否对图像进行归一化。
  • image_meanfloatList[float]可选,默认为 self.image_mean)— 图像均值。
  • image_stdfloatList[float]可选,默认为 self.image_std)— 图像标准差。
  • return_tensorsstrTensorType可选)— 要返回的张量类型。可以是以下之一:
    • 未设置:返回 np.ndarray 列表。
    • TensorType.TENSORFLOW'tf':返回类型为 tf.Tensor 的批次。
    • TensorType.PYTORCH'pt':返回类型为 torch.Tensor 的批次。
    • TensorType.NUMPY'np':返回类型为 np.ndarray 的批次。
    • TensorType.JAX'jax':返回类型为 jax.numpy.ndarray 的批次。
  • data_formatChannelDimensionstr可选,默认为 ChannelDimension.FIRST)— 输出图像的通道维度格式。可以是以下之一:
    • "channels_first"ChannelDimension.FIRST:图像格式为 (num_channels, height, width)。
    • "channels_last"ChannelDimension.LAST:图像格式为 (height, width, num_channels)。
    • 未设置:使用输入图像的通道维度格式。
  • input_data_formatChannelDimensionstr可选)— 输入图像的通道维度格式。如果未设置,则从输入图像推断通道维度格式。可以是以下之一:
    • "channels_first"ChannelDimension.FIRST:图像格式为 (num_channels, height, width)。
    • "channels_last"ChannelDimension.LAST:图像格式为 (height, width, num_channels)。
    • "none"ChannelDimension.NONE:图像格式为 (height, width)。

预处理图像或图像批次。

Pytorch
隐藏 Pytorch 内容

ConvNextModel

transformers.ConvNextModel

< >

( config )

参数

  • configConvNextConfig)— 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,仅加载配置。查看 from_pretrained() 方法加载模型权重。

基础 ConvNext 模型,输出原始特征,顶部没有任何特定的头部。此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解与一般用法和行为相关的所有事项。

前向传播

( pixel_values: FloatTensor = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.BaseModelOutputWithPoolingAndNoAttentiontuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor 形状为 (batch_size, num_channels, height, width)) — 像素值。可以使用 AutoImageProcessor 获取像素值。有关详细信息,请参阅 ConvNextImageProcessor.call()
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量中的 hidden_states
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。

返回

transformers.modeling_outputs.BaseModelOutputWithPoolingAndNoAttentiontuple(torch.FloatTensor)

一个 transformers.modeling_outputs.BaseModelOutputWithPoolingAndNoAttentiontorch.FloatTensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含根据配置 (ConvNextConfig) 和输入而变化的各种元素。

  • last_hidden_state (torch.FloatTensor 形状为 (batch_size, num_channels, height, width)) — 模型最后一层输出处的隐藏状态序列。

  • pooler_output (torch.FloatTensor 形状为 (batch_size, hidden_size)) — 在空间维度上进行池化操作后的最后一层隐藏状态。

  • hidden_states (tuple(torch.FloatTensor), 可选,当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入的输出,如果模型具有嵌入层,加上每一层的输出)形状为 (batch_size, num_channels, height, width)

    模型在每一层输出处的隐藏状态,以及可选的初始嵌入输出。

ConvNextModel 的前向方法覆盖了 __call__ 特殊方法。

虽然前向传递的配方需要在此函数中定义,但之后应该调用 Module 实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。

示例

>>> from transformers import AutoImageProcessor, ConvNextModel
>>> import torch
>>> from datasets import load_dataset

>>> dataset = load_dataset("huggingface/cats-image", trust_remote_code=True)
>>> image = dataset["test"]["image"][0]

>>> image_processor = AutoImageProcessor.from_pretrained("facebook/convnext-tiny-224")
>>> model = ConvNextModel.from_pretrained("facebook/convnext-tiny-224")

>>> inputs = image_processor(image, return_tensors="pt")

>>> with torch.no_grad():
...     outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state
>>> list(last_hidden_states.shape)
[1, 768, 7, 7]

ConvNextForImageClassification

transformers.ConvNextForImageClassification

< >

( config )

参数

  • config (ConvNextConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,仅加载配置。查看 from_pretrained() 方法以加载模型权重。

在顶部具有图像分类头的 ConvNext 模型(池化特征顶部的线性层),例如用于 ImageNet。

此模型是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块,并参考 PyTorch 文档了解与一般用法和行为相关的所有事项。

前向传播

< >

( pixel_values: FloatTensor = None labels: Optional = None output_hidden_states: Optional = None return_dict: Optional = None ) transformers.modeling_outputs.ImageClassifierOutputWithNoAttentiontuple(torch.FloatTensor)

参数

  • pixel_values (torch.FloatTensor 形状为 (batch_size, num_channels, height, width)) — 像素值。可以使用 AutoImageProcessor 获取像素值。有关详细信息,请参阅 ConvNextImageProcessor.call()
  • 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,则计算分类损失(交叉熵损失)。

返回

transformers.modeling_outputs.ImageClassifierOutputWithNoAttentiontuple(torch.FloatTensor)

一个 transformers.modeling_outputs.ImageClassifierOutputWithNoAttentiontorch.FloatTensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含根据配置 (ConvNextConfig) 和输入而变化的各种元素。

  • loss (torch.FloatTensor 形状为 (1,)可选,当提供 labels 时返回) — 分类(或如果 config.num_labels==1 则为回归)损失。
  • logits (torch.FloatTensor 形状为 (batch_size, config.num_labels)) — 分类(或如果 config.num_labels==1 则为回归)分数(在 SoftMax 之前)。
  • hidden_states (tuple(torch.FloatTensor)可选,当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入的输出,如果模型具有嵌入层,加上每个阶段输出的一个)形状为 (batch_size, num_channels, height, width)。模型在每个阶段输出处的隐藏状态(也称为特征图)。

ConvNextForImageClassification 的前向方法覆盖了 __call__ 特殊方法。

虽然前向传递的配方需要在此函数中定义,但之后应该调用 Module 实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。

示例

>>> from transformers import AutoImageProcessor, ConvNextForImageClassification
>>> import torch
>>> from datasets import load_dataset

>>> dataset = load_dataset("huggingface/cats-image", trust_remote_code=True)
>>> image = dataset["test"]["image"][0]

>>> image_processor = AutoImageProcessor.from_pretrained("facebook/convnext-tiny-224")
>>> model = ConvNextForImageClassification.from_pretrained("facebook/convnext-tiny-224")

>>> inputs = image_processor(image, return_tensors="pt")

>>> with torch.no_grad():
...     logits = model(**inputs).logits

>>> # model predicts one of the 1000 ImageNet classes
>>> predicted_label = logits.argmax(-1).item()
>>> print(model.config.id2label[predicted_label])
tabby, tabby cat
TensorFlow
隐藏 TensorFlow 内容

TFConvNextModel

transformers.TFConvNextModel

< >

( config *inputs add_pooling_layer = True **kwargs )

参数

  • config (ConvNextConfig) — 模型配置类,包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重,仅加载配置。请查看 from_pretrained() 方法以加载模型权重。

不带任何特定头部输出原始特征的裸 ConvNext 模型。此模型继承自 TFPreTrainedModel。检查超类文档以了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入的大小、修剪头部等)。

此模型也是 keras.Model 的子类。将其用作常规 TF 2.0 Keras 模型,并参考 TF 2.0 文档以了解所有与一般用法和行为相关的事项。

transformers 中的 TensorFlow 模型和层接受两种格式作为输入

  • 将所有输入作为关键字参数(如 PyTorch 模型),或
  • 将所有输入作为列表、元组或字典放在第一个位置参数中。

支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持,当使用诸如 model.fit() 之类的方法时,事情应该“正常工作”——只需以 model.fit() 支持的任何格式传递您的输入和标签即可!但是,如果您想在 Keras 方法(如 fit()predict())之外使用第二种格式,例如在使用 Keras Functional API 创建自己的层或模型时,您可以使用三种可能性将所有输入张量收集在第一个位置参数中

  • 仅使用 pixel_values 且没有任何其他内容的单个张量:model(pixel_values)
  • 具有一个或多个输入张量的可变长度列表,按文档字符串中给出的顺序排列:model([pixel_values, attention_mask])model([pixel_values, attention_mask, token_type_ids])
  • 具有一个或多个输入张量的字典,这些张量与文档字符串中给出的输入名称相关联:model({"pixel_values": pixel_values, "token_type_ids": token_type_ids})

请注意,当使用 子类化 创建模型和层时,您无需担心任何这些问题,因为您可以像对任何其他 Python 函数一样传递输入!

调用

< >

( pixel_values: TFModelInputType | None = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None training: bool = False ) transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingtuple(tf.Tensor)

参数

  • pixel_values (np.ndarray, tf.Tensor, List[tf.Tensor] `Dict[str, tf.Tensor]Dict[str, np.ndarray],每个示例必须具有形状 (batch_size, num_channels, height, width)) — 像素值。可以使用 AutoImageProcessor 获取像素值。有关详细信息,请参阅 ConvNextImageProcessor.call()
  • output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量中的 hidden_states。此参数仅可在 Eager 模式下使用,在 Graph 模式下,将使用配置中的值。
  • return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。此参数可在 Eager 模式下使用,在 Graph 模式下,该值将始终设置为 True。

返回

transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingtuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingtf.Tensor 的元组(如果传递了 return_dict=Falseconfig.return_dict=False),包含取决于配置 (ConvNextConfig) 和输入的各种元素。

  • last_hidden_state (tf.Tensor 形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层的输出处的隐藏状态序列。

  • pooler_output (tf.Tensor 形状为 (batch_size, hidden_size)) — 序列的第一个标记(分类标记)的最后一层隐藏状态,并进一步由线性层和 Tanh 激活函数处理。在预训练期间,线性层权重是从下一个句子预测(分类)目标中训练出来的。

    此输出通常不是输入语义内容的良好总结,通常使用整个输入序列的隐藏状态的平均值或池化效果更好。

  • hidden_states (tuple(tf.Tensor), 可选,当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — tf.Tensor 的元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态加上初始嵌入输出。

  • attentions (tuple(tf.Tensor), 可选,当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — tf.Tensor 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    注意力 softmax 之后的注意力权重,用于计算自注意力头中的加权平均值。

TFConvNextModel 的前向方法,覆盖了 __call__ 特殊方法。

虽然前向传递的配方需要在此函数中定义,但之后应该调用 Module 实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。

示例

>>> from transformers import AutoImageProcessor, TFConvNextModel
>>> from PIL import Image
>>> import requests

>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw)

>>> image_processor = AutoImageProcessor.from_pretrained("facebook/convnext-tiny-224")
>>> model = TFConvNextModel.from_pretrained("facebook/convnext-tiny-224")

>>> inputs = image_processor(images=image, return_tensors="tf")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_state

TFConvNextForImageClassification

transformers.TFConvNextForImageClassification

< >

( config: ConvNextConfig *inputs **kwargs )

参数

  • config (ConvNextConfig) — 模型配置类,包含模型的所有参数。使用配置文件进行初始化不会加载与模型关联的权重,只会加载配置。请查看 from_pretrained() 方法以加载模型权重。

在顶部具有图像分类头的 ConvNext 模型(池化特征顶部的线性层),例如用于 ImageNet。

此模型继承自 TFPreTrainedModel。请查看超类文档,了解库为其所有模型实现的通用方法(例如下载或保存、调整输入嵌入的大小、剪枝 head 等)。

此模型也是 keras.Model 的子类。将其用作常规 TF 2.0 Keras 模型,并参考 TF 2.0 文档以了解所有与一般用法和行为相关的事项。

transformers 中的 TensorFlow 模型和层接受两种格式作为输入

  • 将所有输入作为关键字参数(如 PyTorch 模型),或
  • 将所有输入作为列表、元组或字典放在第一个位置参数中。

支持第二种格式的原因是 Keras 方法在将输入传递给模型和层时更喜欢这种格式。由于这种支持,当使用诸如 model.fit() 之类的方法时,事情应该“正常工作”——只需以 model.fit() 支持的任何格式传递您的输入和标签即可!但是,如果您想在 Keras 方法(如 fit()predict())之外使用第二种格式,例如在使用 Keras Functional API 创建自己的层或模型时,您可以使用三种可能性将所有输入张量收集在第一个位置参数中

  • 仅使用 pixel_values 且没有任何其他内容的单个张量:model(pixel_values)
  • 具有一个或多个输入张量的可变长度列表,按文档字符串中给出的顺序排列:model([pixel_values, attention_mask])model([pixel_values, attention_mask, token_type_ids])
  • 具有一个或多个输入张量的字典,这些张量与文档字符串中给出的输入名称相关联:model({"pixel_values": pixel_values, "token_type_ids": token_type_ids})

请注意,当使用 子类化 创建模型和层时,您无需担心任何这些问题,因为您可以像对任何其他 Python 函数一样传递输入!

调用

< >

( pixel_values: TFModelInputType | None = None output_hidden_states: Optional[bool] = None return_dict: Optional[bool] = None labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) transformers.modeling_tf_outputs.TFSequenceClassifierOutputtuple(tf.Tensor)

参数

  • pixel_values (np.ndarray, tf.Tensor, List[tf.Tensor] `Dict[str, tf.Tensor]Dict[str, np.ndarray],并且每个示例必须具有形状 (batch_size, num_channels, height, width)) — 像素值。可以使用 AutoImageProcessor 获取像素值。有关详细信息,请参阅 ConvNextImageProcessor.call()
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。有关更多详细信息,请参阅返回张量中的 hidden_states。此参数只能在渴望模式下使用,在图形模式下将使用配置中的值。
  • return_dict (bool可选) — 是否返回 ModelOutput 而不是普通元组。此参数可以在渴望模式下使用,在图形模式下,该值将始终设置为 True。
  • labels (tf.Tensornp.ndarray 形状为 (batch_size,)可选) — 用于计算图像分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 中。如果 config.num_labels == 1,则计算回归损失(均方误差损失),如果 config.num_labels > 1,则计算分类损失(交叉熵)。

返回

transformers.modeling_tf_outputs.TFSequenceClassifierOutputtuple(tf.Tensor)

一个 transformers.modeling_tf_outputs.TFSequenceClassifierOutputtf.Tensor 的元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),包含取决于配置 (ConvNextConfig) 和输入的各种元素。

  • loss (tf.Tensor 形状为 (batch_size, )可选,在提供 labels 时返回) — 分类(或如果 config.num_labels==1 则为回归)损失。

  • logits (tf.Tensor 形状为 (batch_size, config.num_labels)) — 分类(或如果 config.num_labels==1 则为回归)分数(在 SoftMax 之前)。

  • hidden_states (tuple(tf.Tensor), 可选,当传递 output_hidden_states=Trueconfig.output_hidden_states=True 时返回) — tf.Tensor 的元组(一个用于嵌入的输出 + 一个用于每一层的输出),形状为 (batch_size, sequence_length, hidden_size)

    模型在每一层输出处的隐藏状态加上初始嵌入输出。

  • attentions (tuple(tf.Tensor), 可选,当传递 output_attentions=Trueconfig.output_attentions=True 时返回) — tf.Tensor 的元组(每一层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

    注意力 softmax 之后的注意力权重,用于计算自注意力头中的加权平均值。

TFConvNextForImageClassification 正向方法覆盖了 __call__ 特殊方法。

虽然前向传递的配方需要在此函数中定义,但之后应该调用 Module 实例而不是此函数,因为前者负责运行预处理和后处理步骤,而后者则默默地忽略它们。

示例

>>> from transformers import AutoImageProcessor, TFConvNextForImageClassification
>>> import tensorflow as tf
>>> from PIL import Image
>>> import requests

>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> image = Image.open(requests.get(url, stream=True).raw)

>>> image_processor = AutoImageProcessor.from_pretrained("facebook/convnext-tiny-224")
>>> model = TFConvNextForImageClassification.from_pretrained("facebook/convnext-tiny-224")

>>> inputs = image_processor(images=image, return_tensors="tf")
>>> outputs = model(**inputs)
>>> logits = outputs.logits
>>> # model predicts one of the 1000 ImageNet classes
>>> predicted_class_idx = tf.math.argmax(logits, axis=-1)[0]
>>> print("Predicted class:", model.config.id2label[int(predicted_class_idx)])
< > 在 GitHub 上更新