Transformers 文档
ImageGPT
并获得增强的文档体验
开始使用
该模型于 2021 年 11 月 18 日贡献给 Hugging Face Transformers。
ImageGPT
概述
ImageGPT 模型由 Mark Chen、Alec Radford、Rewon Child、Jeffrey Wu、Heewoo Jun、David Luan 和 Ilya Sutskever 在 从像素进行生成式预训练 (Generative Pretraining from Pixels) 一文中提出。ImageGPT (iGPT) 是一个类 GPT-2 模型，通过预测下一个像素值进行训练，支持无条件和有条件图像生成。
论文摘要如下：
受到自然语言无监督表征学习进展的启发，我们探讨了类似的模型是否能为图像学习到有用的表征。我们训练了一个序列 Transformer 模型来自回归地预测像素，而不引入任何二维输入结构知识。尽管在没有标签的低分辨率 ImageNet 上进行训练，但我们发现，GPT-2 规模的模型通过线性探测（linear probing）、微调和少样本分类测量，学到了强大的图像表征。在 CIFAR-10 上，通过线性探测我们达到了 96.3% 的准确率，优于有监督的 Wide ResNet；通过完全微调达到了 99.0% 的准确率，与顶级有监督预训练模型持平。当我们用 VQVAE 编码代替像素时，我们在 ImageNet 上的自监督基准测试中也具有竞争力，在特征线性探测上达到了 69.0% 的 Top-1 准确率。
方法总结。摘自[原始论文](https://cdn.openai.com/papers/Generative_Pretraining_from_Pixels_V2.pdf)。此模型由 nielsr 基于 此问题 贡献。原始代码可以在 这里 找到。
使用技巧
- ImageGPT 与 GPT-2 几乎完全相同，区别在于它使用了不同的激活函数（即“quick gelu”），且层归一化（layer normalization）层不会对输入进行中心化。此外，ImageGPT 没有绑定输入和输出嵌入。
- 由于 Transformer 注意力机制的时间和内存需求与序列长度成平方比，作者在较小的输入分辨率（如 32x32 和 64x64）上对 ImageGPT 进行了预训练。然而，将 32x32x3=3072 个 0 到 255 之间的 token 序列输入到 Transformer 中仍然过大。因此，作者对 (R,G,B) 像素值应用了 k-means 聚类，令 k=512。这样，序列长度缩短为 32*32 = 1024，但数值变为 0 到 511 之间的整数。因此，我们以牺牲更大的嵌入矩阵为代价缩小了序列长度。换句话说，ImageGPT 的词汇表大小为 512，外加一个用于每个序列开头的特殊“句子开始”（SOS）标记。用户可以使用 ImageGPTImageProcessor 为模型准备图像。
- 尽管完全是在无监督的情况下（即不使用任何标签）进行预训练，但 ImageGPT 产生的图像特征在下游任务（如图像分类）中表现相当出色。作者表明，网络中间层的特征表现最好，可以直接用于训练线性模型（例如 sklearn 逻辑回归模型）。这也称为“线性探测”。通过首先将图像前向传播通过模型，然后指定
output_hidden_states=True，最后对所需的层进行隐藏状态的平均池化，即可轻松获得特征。 - 或者，用户也可以像 BERT 一样，在下游数据集上对整个模型进行进一步微调。为此，可以使用 ImageGPTForImageClassification。
- ImageGPT 有不同的大小：包括 ImageGPT-small、ImageGPT-medium 和 ImageGPT-large。作者还训练了一个 XL 变体，但没有发布。不同尺寸的差异总结在下表中
| 模型变体 | 深度 | 隐藏层大小 | 解码器隐藏层大小 | 参数 (M) | ImageNet-1k Top 1 |
|---|---|---|---|---|---|
| MiT-b0 | [2, 2, 2, 2] | [32, 64, 160, 256] | 256 | 3.7 | 70.5 |
| MiT-b1 | [2, 2, 2, 2] | [64, 128, 320, 512] | 256 | 14.0 | 78.7 |
| MiT-b2 | [3, 4, 6, 3] | [64, 128, 320, 512] | 768 | 25.4 | 81.6 |
| MiT-b3 | [3, 4, 18, 3] | [64, 128, 320, 512] | 768 | 45.2 | 83.1 |
| MiT-b4 | [3, 8, 27, 3] | [64, 128, 320, 512] | 768 | 62.6 | 83.6 |
| MiT-b5 | [3, 6, 40, 3] | [64, 128, 320, 512] | 768 | 82.0 | 83.8 |
资源
帮助您开始使用 ImageGPT 的官方 Hugging Face 和社区（以 🌎 标示）资源列表。
- ImageGPT 的演示笔记本可以在 这里 找到。
- ImageGPTForImageClassification 由此 示例脚本 和 笔记本 支持。
- 另请参阅：图像分类任务指南
如果您有兴趣在此处提交资源，请随时开启 Pull Request，我们将对其进行审查！该资源最好能展示一些新内容，而不是重复现有资源。
ImageGPTConfig
class transformers.ImageGPTConfig
< 源代码 >( transformers_version: str | None = None architectures: list[str] | None = None output_hidden_states: bool | None = False return_dict: bool | None = True dtype: typing.Union[str, ForwardRef('torch.dtype'), NoneType] = None chunk_size_feed_forward: int = 0 is_encoder_decoder: bool = False id2label: dict[int, str] | dict[str, str] | None = None label2id: dict[str, int] | dict[str, str] | None = None problem_type: typing.Optional[typing.Literal['regression', 'single_label_classification', 'multi_label_classification']] = None vocab_size: int = 513 n_positions: int = 1024 n_embd: int = 512 n_layer: int = 24 n_head: int = 8 n_inner: int | None = None activation_function: str = 'quick_gelu' resid_pdrop: float | int = 0.1 embd_pdrop: float | int = 0.1 attn_pdrop: float | int = 0.1 layer_norm_epsilon: float = 1e-05 initializer_range: float = 0.02 scale_attn_weights: bool = True use_cache: bool = True tie_word_embeddings: bool = False scale_attn_by_inverse_layer_idx: bool = False reorder_and_upcast_attn: bool = False add_cross_attention: bool = False pad_token_id: int | None = None bos_token_id: int | None = None eos_token_id: int | list[int] | None = None )
参数
- vocab_size (
int, 可选, 默认为513) — 模型的词汇表大小。定义了input_ids可以表示的不同 token 的数量。 - n_positions (
int, 可选, 默认为1024) — 此模型可能使用的最大序列长度。 - n_embd (
int, 可选, 默认为512) — 嵌入和隐藏状态的维度。 - n_layer (
int, 可选, 默认为24) — Transformer 解码器中的隐藏层数量。 - n_head (
int, 可选, 默认为8) — Transformer 解码器中每个注意力层的注意力头数。 - n_inner (
int, 可选) — MLP 表征的维度。 - activation_function (
str, 可选, 默认为quick_gelu) — 解码器中的非线性激活函数（函数或字符串）。例如"gelu"、"relu"、"silu"等。 - resid_pdrop (
Union[float, int], 可选, 默认为0.1) — 嵌入、编码器和池化层中所有全连接层的丢弃概率。 - embd_pdrop (
Union[float, int], 可选, 默认为0.1) — 嵌入层的丢弃比率。 - attn_pdrop (
Union[float, int], 可选, 默认为0.1) — 注意力概率的丢弃比率。 - layer_norm_epsilon (
float, 可选, 默认为1e-05) — 层归一化层使用的 epsilon。 - initializer_range (
float, 可选, 默认为0.02) — 用于初始化所有权重矩阵的截断正态初始化器（truncated_normal_initializer）的标准差。 - scale_attn_weights (
bool, 可选, 默认为True) — 是否通过除以 sqrt(d_model) 来缩放嵌入。 - use_cache (
bool, 可选, 默认为True) — 模型是否应返回最后的键/值注意力（并非所有模型都使用）。仅当config.is_decoder=True或模型为纯解码器生成模型时相关。 - tie_word_embeddings (
bool, 可选, 默认为False) — 是否根据模型的tied_weights_keys映射绑定权重嵌入。 - scale_attn_by_inverse_layer_idx (
bool, 可选, 默认为False) — 是否通过1 / layer_idx + 1额外缩放注意力权重。 - reorder_and_upcast_attn (
bool, 可选, 默认为False) — 是否在计算注意力（点积）之前缩放键 (K)，并在混合精度训练时将注意力点积/softmax 转换为 float()。 - add_cross_attention (
bool, 可选, 默认为False) — 是否应向模型添加交叉注意力层。 - pad_token_id (
int, 可选) — 词汇表中用于填充的 token ID。 - bos_token_id (
int, 可选) — 词汇表中用于序列开始的 token ID。 - eos_token_id (
Union[int, list[int]], 可选) — 词汇表中用于序列结束的 token ID。
这是用于存储 ImageGPTModel 配置的配置类。它根据指定的参数实例化 ImageGPT 模型，定义模型架构。使用默认值实例化配置将产生与 openai/imagegpt-small 类似的配置。
配置对象继承自 PreTrainedConfig，可用于控制模型输出。阅读 PreTrainedConfig 的文档以获取更多信息。
示例
>>> from transformers import ImageGPTConfig, ImageGPTModel
>>> # Initializing a ImageGPT configuration
>>> configuration = ImageGPTConfig()
>>> # Initializing a model (with random weights) from the configuration
>>> model = ImageGPTModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configImageGPTImageProcessor
class transformers.ImageGPTImageProcessor
< 源码 >( clusters: list | numpy.ndarray | torch.Tensor | None = None **kwargs: typing_extensions.Unpack[transformers.models.imagegpt.image_processing_imagegpt.ImageGPTImageProcessorKwargs] )
参数
- clusters (
np.ndarray或list[list[int]]或torch.Tensor, 可选) — 进行颜色量化时使用的颜色聚类，形状为(n_clusters, 3)。可以通过preprocess中的clusters进行覆盖。 - clusters (
np.ndarray, kwargs 或list[list[int]]或torch.Tensor, 可选, 默认为self.clusters) — 进行颜色量化时使用的颜色聚类，形状为(n_clusters, 3)。可以通过preprocess中的clusters进行覆盖。 - do_color_quantize (
bool, kwargs, 可选, 默认为self.do_color_quantize) — 控制是否应用颜色量化将连续像素值转换为离散的聚类索引。当为 True 时，每个像素将被分配到其最近的颜色聚类，从而实现 ImageGPT 的离散标记建模。 - **kwargs (ImagesKwargs, 可选) — 其他图像预处理选项。模型特定的 kwargs 列在上面；请查阅 TypedDict 类以获取支持的参数的完整列表。
构造一个 ImageGPTImageProcessor 图像处理器。
preprocess
< 源码 >( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] *args **kwargs: typing_extensions.Unpack[transformers.processing_utils.ImagesKwargs] ) → ~image_processing_base.BatchFeature
参数
- images (
Union[PIL.Image.Image, numpy.ndarray, torch.Tensor, list[PIL.Image.Image], list[numpy.ndarray], list[torch.Tensor]]) — 需要预处理的图像。期望输入单个或一批像素值在 0 到 255 之间的图像。如果传入像素值在 0 到 1 之间的图像，请设置do_rescale=False。 - return_tensors (
str或 TensorType, 可选) — 如果设置为'pt'，则返回堆叠后的张量，否则返回张量列表。 - **kwargs (ImagesKwargs, 可选) — 其他图像预处理选项。模型特定的 kwargs 列在上面；请查阅 TypedDict 类以获取支持的参数的完整列表。
返回
~image_processing_base.BatchFeature
- data (
dict) — 由 call 方法返回的列表/数组/张量字典（“pixel_values”等）。 - tensor_type (
Union[None, str, TensorType], optional) — 您可以在此处提供 tensor_type 以在初始化时将整数列表转换为 PyTorch/Numpy 张量。
ImageGPTImageProcessorPil
class transformers.ImageGPTImageProcessorPil
< 源码 >( clusters: list | np.ndarray | torch.Tensor | None = None **kwargs: typing_extensions.Unpack[transformers.models.imagegpt.image_processing_pil_imagegpt.ImageGPTImageProcessorKwargs] )
参数
- clusters (
np.ndarray或list[list[int]]或torch.Tensor, 可选) — 进行颜色量化时使用的颜色聚类，形状为(n_clusters, 3)。可以通过preprocess中的clusters进行覆盖。 - clusters (
np.ndarray, kwargs 或list[list[int]]或torch.Tensor, 可选, 默认为self.clusters) — 进行颜色量化时使用的颜色聚类，形状为(n_clusters, 3)。可以通过preprocess中的clusters进行覆盖。 - do_color_quantize (
bool, kwargs, 可选, 默认为self.do_color_quantize) — 控制是否应用颜色量化将连续像素值转换为离散的聚类索引。当为 True 时，每个像素将被分配到其最近的颜色聚类，从而实现 ImageGPT 的离散标记建模。 - **kwargs (ImagesKwargs, 可选) — 其他图像预处理选项。模型特定的 kwargs 列在上面；请查阅 TypedDict 类以获取支持的参数的完整列表。
构造一个 ImageGPTImageProcessor 图像处理器。
preprocess
< 源码 >( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']] *args **kwargs: typing_extensions.Unpack[transformers.processing_utils.ImagesKwargs] ) → ~image_processing_base.BatchFeature
参数
- images (
Union[PIL.Image.Image, numpy.ndarray, torch.Tensor, list[PIL.Image.Image], list[numpy.ndarray], list[torch.Tensor]]) — 需要预处理的图像。期望输入单个或一批像素值在 0 到 255 之间的图像。如果传入像素值在 0 到 1 之间的图像，请设置do_rescale=False。 - return_tensors (
str或 TensorType, 可选) — 如果设置为'pt'，则返回堆叠后的张量，否则返回张量列表。 - **kwargs (ImagesKwargs, 可选) — 其他图像预处理选项。模型特定的 kwargs 列在上面；请查阅 TypedDict 类以获取支持的参数的完整列表。
返回
~image_processing_base.BatchFeature
- data (
dict) — 由 call 方法返回的列表/数组/张量字典（“pixel_values”等）。 - tensor_type (
Union[None, str, TensorType], optional) — 您可以在此处提供 tensor_type 以在初始化时将整数列表转换为 PyTorch/Numpy 张量。
ImageGPTModel
class transformers.ImageGPTModel
< 源码 >( config: ImageGPTConfig )
参数
- config (ImageGPTConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
基础 ImageGPT 模型，输出原始隐藏状态，顶部没有任何特定的头部。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源码 >( input_ids: torch.Tensor | None = None past_key_values: transformers.cache_utils.Cache | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None encoder_hidden_states: torch.Tensor | None = None encoder_attention_mask: torch.Tensor | None = None use_cache: bool | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs: typing.Any ) → BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, input_ids_length)) —input_ids_length=sequence_length（如果past_key_values为None）或者past_key_values.get_seq_length()（输入过去键值状态的sequence_length）。词表中输入序列标记的索引。如果使用
past_key_values，则仅应将尚未计算其过去状态的input_ids作为input_ids传入。可以使用 AutoImageProcessor 获取索引。详情请参见
ImageGPTImageProcessor.__call__()。 - past_key_values (
~cache_utils.Cache, 可选) — 预计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），可用于加速序列解码。这通常由模型在解码的上一阶段返回的past_key_values组成，当use_cache=True或config.use_cache=True时使用。仅允许使用 Cache 实例作为输入，详见我们的 kv 缓存指南。如果不传递
past_key_values，则默认初始化 DynamicCache。模型将输出与输入格式相同的缓存。
如果使用了
past_key_values，用户仅需输入未处理的input_ids（即那些没有将其过去键值状态提供给此模型的输入），其形状应为(batch_size, unprocessed_length)，而不是形状为(batch_size, sequence_length)的所有input_ids。 - attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
- token_type_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于指示输入的第一部分和第二部分的段标记索引。索引在[0, 1]中选择：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- position_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。在[0, config.n_positions - 1]范围内选择。 - inputs_embeds (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 作为一个选项，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为相关向量，这非常有用。 - encoder_hidden_states (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层的输出隐藏状态序列。如果模型配置为解码器，则用于交叉注意力。 - encoder_attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对编码器输入的填充标记索引执行注意力的掩码。如果模型配置为解码器，该掩码在交叉注意力中使用。掩码值在[0, 1]中选择：- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
- use_cache (
bool，可选) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（参见past_key_values）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。
返回
BaseModelOutputWithPastAndCrossAttentions 或 tuple(torch.FloatTensor)
根据配置（ImageGPTConfig）和输入，返回 BaseModelOutputWithPastAndCrossAttentions 或 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素。
ImageGPTModel 的前向传播方法，覆盖了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
last_hidden_state (
torch.FloatTensor, 形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。如果使用了
past_key_values，则只输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。past_key_values (
Cache，*可选*，当传入use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。欲了解更多细节，请参阅我们的 KV 缓存指南。Contains pre-computed hidden-states (key and values in the self-attention blocks and optionally if
config.is_encoder_decoder=Truein the cross-attention blocks) that can be used (seepast_key_valuesinput) to speed up sequential decoding.hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
cross_attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueandconfig.add_cross_attention=Trueis passed or whenconfig.output_attentions=True) — Tuple oftorch.FloatTensor(one for each layer) of shape(batch_size, num_heads, sequence_length, sequence_length).解码器交叉注意力层的注意力权重，在注意力 softmax 之后，用于计算交叉注意力头中的加权平均。
示例
>>> from transformers import AutoImageProcessor, ImageGPTModel
>>> from PIL import Image
>>> import httpx
>>> from io import BytesIO
>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> with httpx.stream("GET", url) as response:
... image = Image.open(BytesIO(response.read()))
>>> image_processor = AutoImageProcessor.from_pretrained("openai/imagegpt-small")
>>> model = ImageGPTModel.from_pretrained("openai/imagegpt-small")
>>> inputs = image_processor(images=image, return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateImageGPTForCausalImageModeling
class transformers.ImageGPTForCausalImageModeling
< 源代码 >( config: ImageGPTConfig )
参数
- config (ImageGPTConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化模型不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法以加载模型权重。
带有语言建模头（线性层，权重与输入嵌入绑定）的 ImageGPT 模型转换器。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源代码 >( input_ids: torch.Tensor | None = None, past_key_values: transformers.cache_utils.Cache | None = None, attention_mask: torch.Tensor | None = None, token_type_ids: torch.Tensor | None = None, position_ids: torch.Tensor | None = None, inputs_embeds: torch.Tensor | None = None, encoder_hidden_states: torch.Tensor | None = None, encoder_attention_mask: torch.Tensor | None = None, labels: torch.Tensor | None = None, use_cache: bool | None = None, output_attentions: bool | None = None, output_hidden_states: bool | None = None, return_dict: bool | None = None, **kwargs: typing.Any ) → CausalLMOutputWithCrossAttentions 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, input_ids_length)) — 如果past_key_values为None，则input_ids_length=sequence_length，否则为past_key_values.get_seq_length()（过去键值状态的sequence_length）。输入序列标记在词汇表中的索引。如果使用了
past_key_values，则仅应将尚未计算其过去状态的input_ids作为input_ids传递。索引可以使用 AutoImageProcessor 获取。详细信息请参见
ImageGPTImageProcessor.__call__()。 - past_key_values (
~cache_utils.Cache，可选) — 预计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），可用于加速序列解码。这通常由模型在解码的上一阶段返回的past_key_values组成，当use_cache=True或config.use_cache=True时使用。仅允许使用 Cache 实例作为输入，详见我们的 kv 缓存指南。如果不传递
past_key_values，则默认初始化 DynamicCache。模型将输出与输入格式相同的缓存。
如果使用了
past_key_values，用户仅需输入未处理的input_ids（即那些没有将其过去键值状态提供给此模型的输入），其形状应为(batch_size, unprocessed_length)，而不是形状为(batch_size, sequence_length)的所有input_ids。 - attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值在[0, 1]中选择：- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
- token_type_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于指示输入的第一部分和第二部分的段标记索引。索引在[0, 1]中选择：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- position_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。在[0, config.n_positions - 1]范围内选择。 - inputs_embeds (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 作为一个选项，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为相关向量，这非常有用。 - encoder_hidden_states (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 编码器最后一层的输出隐藏状态序列。如果模型配置为解码器，则用于交叉注意力。 - encoder_attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对编码器输入的填充标记索引执行注意力的掩码。如果模型配置为解码器，该掩码在交叉注意力中使用。掩码值在[0, 1]中选择：- 1 表示未被掩码的标记，
- 0 表示被掩码的标记。
- labels (
torch.LongTensor，形状为(batch_size, input_ids_length)，可选) — 用于语言建模的标签。请注意，标签在模型内部进行了移动，即您可以设置labels = input_ids。索引在[-100, 0, ..., config.vocab_size]中选择。所有设置为-100的标签都会被忽略（掩码），损失仅针对[0, ..., config.vocab_size]中的标签进行计算。 - use_cache (
bool, optional) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（参见past_key_values）。 - output_attentions (
bool, optional) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool, optional) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的hidden_states。 - return_dict (
bool, optional) — 是否返回 ModelOutput 而非普通元组。
返回
CausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)
一个 CausalLMOutputWithCrossAttentions 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（ImageGPTConfig）和输入，包含不同的元素。
ImageGPTForCausalImageModeling 的 forward 方法，重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。logits (形状为
(batch_size, sequence_length, config.vocab_size)的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 后的注意力权重，用于计算自注意力头中的加权平均值。
cross_attentions (
tuple(torch.FloatTensor), optional, returned whenoutput_attentions=Trueis passed or whenconfig.output_attentions=True) — Tuple oftorch.FloatTensor(one for each layer) of shape(batch_size, num_heads, sequence_length, sequence_length).注意力 softmax 后的交叉注意力权重，用于计算交叉注意力头中的加权平均。
past_key_values (
Cache，*可选*，当传入use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。欲了解更多细节，请参阅我们的 KV 缓存指南。包含预先计算的隐藏状态（注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。
示例
>>> from transformers import AutoImageProcessor, ImageGPTForCausalImageModeling
>>> import torch
>>> import matplotlib.pyplot as plt
>>> import numpy as np
>>> image_processor = AutoImageProcessor.from_pretrained("openai/imagegpt-small")
>>> model = ImageGPTForCausalImageModeling.from_pretrained("openai/imagegpt-small")
>>> device = torch.device("cuda" if torch.cuda.is_available() else "cpu")
>>> model.to(device)
>>> # unconditional generation of 8 images
>>> batch_size = 4
>>> context = torch.full((batch_size, 1), model.config.vocab_size - 1) # initialize with SOS token
>>> context = context.to(device)
>>> output = model.generate(
... input_ids=context, max_length=model.config.n_positions + 1, temperature=1.0, do_sample=True, top_k=40
... )
>>> clusters = image_processor.clusters
>>> height = image_processor.size["height"]
>>> width = image_processor.size["width"]
>>> samples = output[:, 1:].detach().cpu().numpy()
>>> samples_img = [
... np.reshape(np.rint(127.5 * (clusters[s] + 1.0)), [height, width, 3]).astype(np.uint8) for s in samples
... ] # convert color cluster tokens back to pixels
>>> f, axes = plt.subplots(1, batch_size, dpi=300)
>>> for img, ax in zip(samples_img, axes):
... ax.axis("off")
... ax.imshow(img)ImageGPTForImageClassification
class transformers.ImageGPTForImageClassification
< 源代码 >( config: ImageGPTConfig )
参数
- config (ImageGPTConfig) — 模型配置类，包含模型的所有参数。使用配置对象初始化不会加载与模型相关的权重，仅加载配置。请查看 from_pretrained() 方法来加载模型权重。
带有图像分类头（线性层）的 ImageGPT 模型转换器。ImageGPTForImageClassification 对隐藏状态进行平均池化以执行分类。
该模型继承自 PreTrainedModel。请查看超类文档以了解该库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等）。
此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它，并参考 PyTorch 文档了解一般用法和行为的所有相关信息。
forward
< 源代码 >( input_ids: torch.Tensor | None = None past_key_values: transformers.cache_utils.Cache | None = None attention_mask: torch.Tensor | None = None token_type_ids: torch.Tensor | None = None position_ids: torch.Tensor | None = None inputs_embeds: torch.Tensor | None = None labels: torch.Tensor | None = None use_cache: bool | None = None output_attentions: bool | None = None output_hidden_states: bool | None = None return_dict: bool | None = None **kwargs: typing.Any ) → SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, input_ids_length)) —input_ids_length=sequence_length（如果past_key_values为None），否则为past_key_values.get_seq_length()（输入过去键值状态的sequence_length）。词汇表中输入序列 token 的索引。如果使用了
past_key_values，则只需将尚未计算其过去的input_ids作为input_ids传递。索引可以使用 AutoImageProcessor 获取。详细信息请参阅
ImageGPTImageProcessor.__call__()。 - past_key_values (
~cache_utils.Cache, 可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常由模型在解码的前一阶段返回，当use_cache=True或config.use_cache=True时。仅允许使用 Cache 实例作为输入，请参阅我们的 kv 缓存指南。如果未传递
past_key_values，则默认初始化 DynamicCache。模型将输出与输入格式相同的缓存。
如果使用了
past_key_values，用户应仅输入未处理的input_ids（那些尚未将其过去键值状态提供给此模型的输入），其形状为(batch_size, unprocessed_length)，而不是形状为(batch_size, sequence_length)的所有input_ids。 - attention_mask (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 用于避免对填充 token 索引执行注意力的掩码。掩码值选自[0, 1]：- 1 表示未被掩码的 token，
- 0 表示被掩码的 token。
- token_type_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 段 token 索引，用于指示输入的第 1 部分和第 2 部分。索引选自[0, 1]：- 0 对应于句子 A token，
- 1 对应于句子 B token。
- position_ids (
torch.Tensor，形状为(batch_size, sequence_length)，可选) — 每个输入序列 token 在位置嵌入中的位置索引。选自范围[0, config.n_positions - 1]。 - inputs_embeds (
torch.Tensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，你可以选择直接传递嵌入表示，而不是传递input_ids。如果你想比模型内部的嵌入查找矩阵更精细地控制如何将input_ids索引转换为相关向量，这非常有用。 - labels (
torch.LongTensor，形状为(batch_size,)，可选) — 用于计算序列分类/回归损失的标签。索引应在[0, ..., config.num_labels - 1]范围内。如果config.num_labels == 1，则计算回归损失（均方损失）；如果config.num_labels > 1，则计算分类损失（交叉熵损失）。 - use_cache (
bool, 可选) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（参见past_key_values）。 - output_attentions (
bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参见返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参见返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而非普通元组。
返回
SequenceClassifierOutputWithPast 或 tuple(torch.FloatTensor)
一个 SequenceClassifierOutputWithPast 或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），根据配置（ImageGPTConfig）和输入，包含不同的元素。
ImageGPTForImageClassification 的 forward 方法，重写了 __call__ 特殊方法。
虽然 forward pass 的实现需要在此函数中定义，但你应该在之后调用
Module实例而不是这个，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
loss (形状为
(1,)的torch.FloatTensor，可选，当提供labels时返回) — 分类损失（如果 config.num_labels==1，则为回归损失）。logits (形状为
(batch_size, config.num_labels)的torch.FloatTensor) — 分类（如果 config.num_labels==1，则为回归）分数（SoftMax 之前）。past_key_values (
Cache，*可选*，当传入use_cache=True或config.use_cache=True时返回) — 这是一个 Cache 实例。欲了解更多细节，请参阅我们的 KV 缓存指南。包含预计算的隐藏状态（自注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。hidden_states (
tuple(torch.FloatTensor), optional, 当传递output_hidden_states=True或当config.output_hidden_states=True时返回) —torch.FloatTensor的元组（一个用于嵌入层的输出，如果模型有嵌入层；+一个用于每个层的输出），形状为(batch_size, sequence_length, hidden_size)。模型在每个层输出的隐藏状态以及可选的初始嵌入输出。
attentions (
tuple(torch.FloatTensor), optional, 当传递output_attentions=True或当config.output_attentions=True时返回) —torch.FloatTensor的元组（每个层一个），形状为(batch_size, num_heads, sequence_length, sequence_length)。注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
示例
>>> from transformers import AutoImageProcessor, ImageGPTForImageClassification
>>> from PIL import Image
>>> import httpx
>>> from io import BytesIO
>>> url = "http://images.cocodataset.org/val2017/000000039769.jpg"
>>> with httpx.stream("GET", url) as response:
... image = Image.open(BytesIO(response.read()))
>>> image_processor = AutoImageProcessor.from_pretrained("openai/imagegpt-small")
>>> model = ImageGPTForImageClassification.from_pretrained("openai/imagegpt-small")
>>> inputs = image_processor(images=image, return_tensors="pt")
>>> outputs = model(**inputs)
>>> logits = outputs.logits