ConvNeXt V2
概述
ConvNeXt V2 模型由 Sanghyun Woo、Shoubhik Debnath、Ronghang Hu、Xinlei Chen、Zhuang Liu、In So Kweon 和 Saining Xie 在 ConvNeXt V2：使用掩码自动编码器协同设计和扩展卷积神经网络 中提出。ConvNeXt V2 是一个纯卷积模型（ConvNet），它受到 Vision Transformers 设计的启发，是 ConvNeXT 的后续版本。
论文中的摘要如下：
得益于改进的架构和更强大的表示学习框架，视觉识别领域在 2020 年代初实现了快速现代化和性能提升。例如，以 ConvNeXt 为代表的现代卷积神经网络 (ConvNets) 在各种场景中都表现出了强大的性能。虽然这些模型最初是为使用 ImageNet 标签的监督学习而设计的，但它们也可以从自监督学习技术中获益，例如掩码自动编码器 (MAE)。然而，我们发现简单地将这两种方法结合起来会导致性能下降。在本文中，我们提出了一种全卷积掩码自动编码器框架，以及一个新的全局响应归一化 (GRN) 层，可以添加到 ConvNeXt 架构中以增强通道间特征竞争。这种自监督学习技术和架构改进的协同设计产生了名为 ConvNeXt V2 的新型模型系列，该系列显著提升了纯 ConvNets 在各种识别基准上的性能，包括 ImageNet 分类、COCO 检测和 ADE20K 分割。我们还提供了各种尺寸的预训练 ConvNeXt V2 模型，从一个高效的 3.7M 参数 Atto 模型（在 ImageNet 上的 top-1 准确率为 76.7%）到一个 650M Huge 模型（仅使用公共训练数据即可实现最先进的 88.9% 的准确率）。
ConvNeXt V2 架构。摘自 原始论文。该模型由 adirik 贡献。原始代码可以在这里找到 这里。
资源
以下是一些官方 Hugging Face 和社区（🌎 表示）资源，可帮助您开始使用 ConvNeXt V2。
- ConvNextV2ForImageClassification 由此 示例脚本 和 笔记本 支持。
如果您想提交资源以包含在此处，请随时打开一个 Pull Request，我们会进行审查！理想情况下，资源应该展示一些新内容，而不是重复现有资源。
ConvNextV2Config
class transformers.ConvNextV2Config
< 源代码 >( 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 drop_path_rate = 0.0 image_size = 224 out_features = None out_indices = None **kwargs )
参数
- num_channels (
int, 可选，默认为 3) — 输入通道数。 - patch_size (
int, 可选，默认为 4) — 在 patch 嵌入层中使用的 patch 大小。 - num_stages (
int, 可选，默认为 4) — 模型中的阶段数。 - hidden_sizes (
List[int], 可选，默认为[96, 192, 384, 768]) — 每个阶段的维度（隐藏大小）。 - depths (
List[int], 可选，默认为[3, 3, 9, 3]) — 每个阶段的深度（块的数量）。 - hidden_act (
str或function, 可选, 默认值为"gelu") — 每个块中的非线性激活函数（函数或字符串）。如果为字符串，则支持"gelu"、"relu"、"selu"和"gelu_new"。 - initializer_range (
float, 可选, 默认值为 0.02) — 初始化所有权重矩阵的截断正态分布初始化器的标准差。 - layer_norm_eps (
float, 可选, 默认值为 1e-12) — 层归一化层使用的 epsilon。 - 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属性中定义的顺序相同。
这是一个配置类，用于存储 ConvNextV2Model 的配置。它用于根据指定的参数实例化一个 ConvNeXTV2 模型，定义模型架构。使用默认值实例化配置将产生类似于 ConvNeXTV2 facebook/convnextv2-tiny-1k-224 架构的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PretrainedConfig 的文档。
示例
>>> from transformers import ConvNeXTV2Config, ConvNextV2Model
>>> # Initializing a ConvNeXTV2 convnextv2-tiny-1k-224 style configuration
>>> configuration = ConvNeXTV2Config()
>>> # Initializing a model (with random weights) from the convnextv2-tiny-1k-224 style configuration
>>> model = ConvNextV2Model(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configConvNextV2Model
class transformers.ConvNextV2Model
< 源代码 >( config )
参数
- config (ConvNextV2Config) — 模型配置类，包含模型的所有参数。使用配置文件进行初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
不带任何特定头的 ConvNextV2 模型，输出原始特征。此模型是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解有关一般用法和行为的所有内容。
ConvNextV2Model 正向方法覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, ConvNextV2Model
>>> 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/convnextv2-tiny-1k-224")
>>> model = ConvNextV2Model.from_pretrained("facebook/convnextv2-tiny-1k-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]ConvNextV2ForImageClassification
class transformers.ConvNextV2ForImageClassification
< 源代码 >( config )
参数
- config (ConvNextV2Config) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
在顶部带有图像分类头的 ConvNextV2 模型（在池化特征之上进行线性层），例如，用于 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.ImageClassifierOutputWithNoAttention 或 tuple(torch.FloatTensor)
参数
- pixel_values (
torch.FloatTensor形状为(batch_size, num_channels, height, width)) — 像素值。可以使用 ConvNextImageProcessor 获取像素值。有关详细信息，请参阅 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.ImageClassifierOutputWithNoAttention 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.ImageClassifierOutputWithNoAttention 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包括取决于配置 (ConvNextV2Config) 和输入的各种元素。
- 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)。每个阶段输出的模型的隐藏状态（也称为特征图）。
The ConvNextV2ForImageClassification 正向方法，覆盖 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, ConvNextV2ForImageClassification
>>> 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/convnextv2-tiny-1k-224")
>>> model = ConvNextV2ForImageClassification.from_pretrained("facebook/convnextv2-tiny-1k-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 catTFConvNextV2Model
class transformers.TFConvNextV2Model
< 源代码 >( config: ConvNextV2Config *inputs **kwargs )
参数
- config (ConvNextV2Config) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
仅输出原始特征而不带任何特定头的裸 ConvNextV2 模型。此模型继承自 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.TFBaseModelOutputWithPoolingAndNoAttention 或 tuple(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。
返回
transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingAndNoAttention 或 tuple(tf.Tensor)
transformers.modeling_tf_outputs.TFBaseModelOutputWithPoolingAndNoAttention 或 tf.Tensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包含根据配置 (ConvNextV2Config) 和输入的不同元素。
-
last_hidden_state (
tf.Tensor形状为(batch_size, num_channels, height, width)) — 模型最后一层的输出处的隐藏状态序列。 -
pooler_output (
tf.Tensor形状为(batch_size, hidden_size)) — 在对空间维度进行池化操作后，最后一层的隐藏状态。 -
hidden_states (
tuple(tf.Tensor), 可选，在传递output_hidden_states=True或当config.output_hidden_states=True时返回) —tf.Tensor元组（一个用于嵌入的输出，如果模型具有嵌入层，+ 一个用于每一层的输出）形状为(batch_size, num_channels, height, width)。模型在每一层输出处的隐藏状态，加上可选的初始嵌入输出。
TFConvNextV2Model 正向方法，覆盖了 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, TFConvNextV2Model
>>> 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/convnextv2-tiny-1k-224")
>>> model = TFConvNextV2Model.from_pretrained("facebook/convnextv2-tiny-1k-224")
>>> inputs = image_processor(image, return_tensors="tf")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_state
>>> list(last_hidden_states.shape)
[1, 768, 7, 7]TFConvNextV2ForImageClassification
class transformers.TFConvNextV2ForImageClassification
< 源代码 >( config: ConvNextV2Config *inputs **kwargs )
参数
- config (ConvNextV2Config) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，只会加载配置。查看 from_pretrained() 方法来加载模型权重。
在顶部带有图像分类头的 ConvNextV2 模型（在池化特征之上进行线性层），例如，用于 ImageNet。
此模型继承自 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 labels: np.ndarray | tf.Tensor | None = None training: Optional[bool] = False ) → transformers.modeling_tf_outputs.TFImageClassifierOutputWithNoAttention 或 tuple(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 (形状为
(batch_size,)的tf.Tensor或np.ndarray, 可选) — 用于计算图像分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]中。如果config.num_labels == 1，则计算回归损失（均方损失），如果config.num_labels > 1，则计算分类损失（交叉熵）。
返回
transformers.modeling_tf_outputs.TFImageClassifierOutputWithNoAttention 或 tuple(tf.Tensor)
一个 transformers.modeling_tf_outputs.TFImageClassifierOutputWithNoAttention 或一个 tf.Tensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含取决于配置 (ConvNextV2Config) 和输入的各种元素。
- loss (形状为
(1,)的tf.Tensor, 可选，在提供labels时返回) — 分类（如果 config.num_labels==1 则为回归）损失。 - logits (形状为
(batch_size, config.num_labels)的tf.Tensor) — 分类（如果 config.num_labels==1 则为回归）分数（在 SoftMax 之前）。 - hidden_states (
tuple(tf.Tensor), 可选，在传递output_hidden_states=True或当config.output_hidden_states=True时返回) —tf.Tensor的元组（一个用于嵌入的输出，如果模型具有嵌入层，+ 一个用于每个阶段的输出），形状为(batch_size, num_channels, height, width)。模型在每个阶段输出处的隐藏状态（也称为特征图）。
The TFConvNextV2ForImageClassification 前向方法，覆盖 __call__ 特殊方法。
虽然正向传递的配方需要在此函数中定义，但之后应该调用 Module 实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者则默默地忽略它们。
示例
>>> from transformers import AutoImageProcessor, TFConvNextV2ForImageClassification
>>> import tensorflow as tf
>>> 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/convnextv2-tiny-1k-224")
>>> model = TFConvNextV2ForImageClassification.from_pretrained("facebook/convnextv2-tiny-1k-224")
>>> inputs = image_processor(image, return_tensors="tf")
>>> logits = model(**inputs).logits
>>> # model predicts one of the 1000 ImageNet classes
>>> predicted_label = int(tf.math.argmax(logits, axis=-1))
>>> print(model.config.id2label[predicted_label])
tabby, tabby cat