Transformers

( vocab_size = 65536 hidden_size = 4096 intermediate_size = 11008 num_hidden_layers = 32 num_attention_heads = 32 num_key_value_heads = 32 hidden_act = 'silu' max_position_embeddings = 4096 initializer_range = 0.02 rms_norm_eps = 1e-05 use_cache = True pad_token_id = None bos_token_id = 1 eos_token_id = 2 tie_word_embeddings = False rope_theta = 10000.0 rope_scaling = None attention_bias = False attention_dropout = 0.0 model_parallel_size = 1 swin_norm = False vq_config = None vocabulary_map = None mlp_bias = False **kwargs )

参数

vocab_size (int, 可选, 默认值 65536) —— 仙人_model 的词汇大小。定义了调用 ChameleonModel 时 inputs_ids 传入的不同 tokens 的数量；这包括文本和图像 tokens。
hidden_size (int, 可选, 默认值 4096) —— 隐藏表示的维度。
intermediate_size (int, 可选, 默认值 11008) —— MLP 表示的维度。
num_hidden_layers (int, 可选, 默认值 32) —— Transformer 解码器中的隐藏层数量。
num_attention_heads (int, 可选, 默认为32) — 每个Transformer解码器中的注意力层的注意力头数。
num_key_value_heads (int, 可选, 默认为32) — 要用于实现分组查询注意力的键值头数。如果 num_key_value_heads=num_attention_heads，则模型将使用多头注意（MHA），如果 num_key_value_heads=1，则模型将使用多查询注意（MQA），否则使用GQA。在将多头检查点转换为GQA检查点时，每个组键和值头应该由分组内所有原始头的meanpooling构成。有关更多详细信息，请参阅[此论文](https://arxiv.org/pdf/2305.13245.pdf)。如果没有指定，将默认为 num_attention_heads。
hidden_act (str 或 function, 可选, 默认为 "silu") — 解码器中的非线性激活函数（函数或字符串）。
max_position_embeddings (int, 可选, 默认为 4096) — 此模型可能用到的最大序列长度。Chameleon 支持 4096 个令牌。
initializer_range (float, 可选, 默认为 0.02) — 所有权重矩阵初始化的 truncated_normal_initializer 的标准差。
rms_norm_eps (float, 可选, 默认为 1e-05) — 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。
tie_word_embeddings (bool, 可选, 默认值 False) — 是否绑定词嵌入权重。
rope_theta (float, 可选, 默认为 10000.0) — RoPE 嵌入的基本周期。
rope_scaling (Dict, 可选) — 包含 RoPE 嵌入缩放配置的字典。目前支持两种缩放策略：线性和中动态。它们的缩放因子必须是一个大于 1 的浮点数。预期的格式是 {"type": 策略名称, "factor": 缩放因子}。当使用此标志时，不要更新 max_position_embeddings 到预期的新最大值。有关这些缩放策略行为的更多信息，请参见以下主题：https://www.reddit.com/r/Localchameleon/comments/14mrgpr/dynamically_scaled_rope_further_increases/。这是一个实验特性，未来版本可能会出现破坏性 API 变化。
attention_bias (bool, 默认为 False, 可选) — 在自注意力期间是否使用查询、键、值和输出投影层的偏差。
attention_dropout (float, 可选, 默认为 0.0) — 注意力概率的dropout比率。
model_parallel_size (int, 可选, 默认为 1) — 训练模型时使用的shard数。这将在qk layernorm中用到，因为原始Chameleon推理在这些层中没有reduction，并且每个rank都有自己的偏差。
swin_norm (bool, 可选, 默认为 False) — 使用Swin Transformer标准化。
vq_config (dict, 可选) — 包含用于VQ-VAE模型配置的ChameleonVQConfig实例。
词汇映射（《字典》选项，可选）—— 包含从分词器词汇映射的字典。用于从图像输入中获取令牌。
mlp_bias（《布尔值》选项，可选，默认为False）—— 是否在MLP层中的up_proj、down_proj和gate_proj层中使用偏置。

这是一个配置类，用于存储ChameleonModel的配置。它用于根据指定的参数实例化一个chameleon模型，定义模型架构。使用默认参数实例化配置将得到与meta/chameleon-7B类似的配置。

配置对象继承自PretrainedConfig，可以用于控制模型输出。有关更多信息，请参阅PretrainedConfig文档。

>>> from transformers import ChameleonModel, ChameleonConfig

>>> # Initializing a chameleon chameleon-7b style configuration
>>> configuration = ChameleonConfig()

>>> # Initializing a model from the chameleon-7b style configuration
>>> model = ChameleonModel(configuration)

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

ChameleonVQVAEConfig

类 transformers.ChameleonVQVAEConfig

( embed_dim: int = 256 num_embeddings: int = 8192 double_latent: bool = False latent_channels: int = 256 resolution: int = 512 in_channels: int = 3 base_channels: int = 128 channel_multiplier: List = [1, 1, 2, 2, 4] num_res_blocks: int = 2 attn_resolutions: List = None dropout: float = 0.0 attn_type: str = 'vanilla' initializer_range = 0.02 **kwargs )

参数

embed_dim (int, 可选，默认为 256) — 每个嵌入向量的维度性。
num_embeddings （int，可选，默认为 8192） — 代码本嵌入的数量。
double_latent （bool，可选，默认为 False） — 是否使用双 z 通道。
latent_channels （int，可选，默认为 256） — 潜在空间的通道数量。
resolution （int，可选，默认为 512） — 输入图像的分辨率。
in_channels (int, 可选, 默认为 3) — 输入通道数。
base_channels (int, 可选, 默认为 128) — 基础通道数。
channel_multiplier (List[int], 可选, 默认为 [1, 1, 2, 2, 4]) — 对每个分辨率的通道乘数。
num_res_blocks (int, 可选, 默认为 2) — 非残差块的数量。
attn_resolutions (列表[int], 可选) — 应用注意力的分辨率。
dropout (浮点数, 可选, 默认为0.0) — Dropout比率。
attn_type (字符串, 可选, 默认为"vanilla") — VQ-GAN编码器中使用的注意类型。可以是“vanilla”或None。
initializer_range (浮点数, 可选, 默认为0.02) — 截断正态初始化器初始化所有权重矩阵的标准差。

这是一个用于存储ChameleonVQModel配置的配置类。它用于根据指定的参数实例化ChameleonVQModel，定义模型架构。配置对象继承自PretrainedConfig，可用来控制模型输出。有关更多信息，请阅读PretrainedConfig文档。使用默认值创建配置将生成与meta/chameleon-7B的VQModel类似的配置。

ChameleonProcessor

class transformers.ChameleonProcessor

( 图像处理器分词器图像序列长度: int = 1024 图像令牌: str = '<image>' )

参数

image_processor (ChameleonImageProcessor) — 图像处理器是必需的输入。
tokenizer (LlamaTokenizerFast) — 标记化器是必需的输入。
image_seq_length (int, 可选, 默认为 1024) — 单个图像嵌入的序列长度。
image_token (str, 可选, 默认为 "<image>") — 用于在文本中表示图像的特殊标记。

构造一个Chameleon处理器，该处理器将Chameleon图像处理器和Chameleon标记化器封装成一个单一处理器。

ChameleonProcessor 提供了 ChameleonImageProcessor 和 LlamaTokenizerFast 所有的功能。更多信息请参阅 __call__() 和 decode()。

batch_decode

( *args **kwargs )

此方法将所有参数传递给 LlamaTokenizerFast 的 batch_decode()。有关更多信息，请参阅此方法的文档字符串。

decode

( *args **kwargs )

此方法将所有参数传递给 LlamaTokenizerFast 的 decode()。有关更多信息，请参阅此方法的文档字符串。

ChameleonImageProcessor

类 transformers.ChameleonImageProcessor

( do_resize: bool = True size: Dict = None resample: Resampling = 1 do_center.crop: bool = True crop_size: Dict = None do_rescale: bool = True rescale_factor: Union = 0.0078 do_normalize: bool = True image_mean: Union = None image_std: Union = None do_convert_rgb: bool = True **kwargs )

参数

do_resize (bool, 可选, 默认值为 True) — 是否将图像的（高度，宽度）维度调整到指定的 size。可被 preprocess 方法中的 do_resize 覆盖。
size (Dict[str, int] 可选，默认为 {"shortest_edge" -- 512}): 改变图像大小后的尺寸。图像最短边将调整到 [“shortest_edge”] 的大小，最长边将调整以保持输入的宽高比。可以由 preprocess 方法中的 size 覆盖。
resample (PILImageResampling，可选，默认为 1) — 如果改变图像大小，使用重采样的滤镜。可以由 preprocess 方法中的 resample 覆盖。
do_center_crop (bool，可选，默认为 True) — 是否将图像中心裁剪到指定的 crop_size。可以由 preprocess 方法中的 do_center_crop 覆盖。
crop_size (Dict[str, int] 可选，默认为 {“height” — 512, “width”: 512}): 应用 center_crop 后输出图像的大小。可以被 preprocess 方法中的 crop_size 覆盖。
do_rescale (bool，可选，默认为 True) — 是否根据指定的缩放因子 rescale_factor 进行图像缩放。可以被 preprocess 方法中的 do_rescale 覆盖。
rescale_factor (int 或 float，可选，默认为 0.0078) — 缩放图像时要使用的缩放因子。可以被 preprocess 方法中的 rescale_factor 覆盖。
do_convert_rgb (布尔值, 可选, 默认为 True) — 是否将图像转换为RGB。

构建Chameleon图像处理器。

preprocess

( images: 合并 do_resize: 布尔型 = None size: 字典 = None resample: 重采样 = None do_center_crop: 布尔型 = None crop_size: 整型 = None do_rescale: 布尔型 = None rescale_factor: 浮点 = None do_normalize: 布尔型 = None image_mean: 合并 = None image_std: 合并 = None do_convert_rgb: 布尔型 = None return_tensors: 合并 = None data_format: 可选 = <ChannelDimension.FIRST: 'channels_first'> input_data_format: 合并 = None )

参数

images (ImageInput) — 需要预处理的图像。期望输入像素值介于 0 到 255 之间的单个或批量图像。如果传入像素值在 0 到 1 之间的图像，请设置 do_rescale=False。
do_resize (布尔型) —— 是否调整图像大小。
size (Dict[str, int], 可选, 默认为 self.size) — 改变大小后的图像大小。图像的最短边更改到 size[“shortest_edge”]，以保持输入宽高比，最长边进行相应调整。
resample (int, 可选, 默认为 self.resample) — 图像更改大小时要使用的重采样滤波器。可以是枚举 PILImageResampling 之一。仅在 do_resize 设置为 True 时有效。
do_center_crop (bool, 可选, 默认为 self.do_center_crop) — 是否进行居中裁剪。
crop_size (Dict[str, int], 可选, 默认为 self.crop_size) — 中心裁剪的大小。只有当 do_center_crop 设置为 True 时才有效。
do_rescale (bool, 可选, 默认为 self.do_rescale) — 是否缩放图像。
rescale_factor (float, 可选, 默认为 self.rescale_factor) — 如果 do_rescale 设置为 True，则缩放图像的缩放因子。
do_normalize (bool, 可选, 默认为 self.do_normalize) — 是否对图像进行归一化。
image_mean (float 或 List[float]，可选，默认为 self.image_mean）— 用于归一化的图像均值。仅在将 do_normalize 设置为 True 时生效。
image_std (float 或 List[float]，可选，默认为 self.image_std）— 用于归一化的图像标准差。仅在将 do_normalize 设置为 True 时生效。
do_convert_rgb (bool，可选，默认为 self.do_convert_rgb）— 是否将图像转换为RGB格式。
return_tensors (str 或 TensorType，可选) — 返回的张量类型。可以是以下之一：
- 未设置：返回一个 np.ndarray 列表。
- TensorType.TENSORFLOW 或 'tf'：返回类型为 tf.Tensor 的批量数据。
- TensorType.PYTORCH 或 'pt'：返回类型为 torch.Tensor 的批量数据。
- TensorType.NUMPY 或 'np'：返回类型为 np.ndarray 的批量数据。
- TensorType.JAX 或 'jax'：返回类型为 jax.numpy.ndarray 的批量数据。
data_format (ChannelDimension 或 str，可选，默认为 ChannelDimension.FIRST) — 输出图像的通道维度格式。可以是以下之一：
- "channels_first" 或 ChannelDimension.FIRST：图像格式为 (num_channels, height, width)。
- "channels_last" 或 ChannelDimension.LAST：图像格式为 (height, width, num_channels)。
- 未设置：使用输入图像的通道维度格式。
input_data_format (ChannelDimension 或 str，可选) — 输入图像的通道维数格式。如果未设置，则从输入图像推断通道维数格式。可以是以下之一：
- "channels_first" 或 ChannelDimension.FIRST：图像格式为 (num_channels, height, width)。
- "channels_last" 或 ChannelDimension.LAST：图像格式为 (height, width, num_channels)。
- "none" 或 ChannelDimension.NONE：图像格式为 (height, width)。

预处理图像或图像批。

ChameleonVQVAE

类 transformers.ChameleonVQVAE

( config: ChameleonVQVAEConfig )

参数

config (ChameleonVQVAEConfig) —— 包含模型所有参数的模型配置类。使用配置文件初始化模型时，不会加载模型相关的权重，只会加载配置。请参阅 from_pretrained() 方法以加载模型权重。

Chameleon用于将图像编码/解码为离散令牌的VQ-VAE模型。该模型遵循来自Oran Gafni, Adam Polyak, Oron Ashual, Shelly Sheynin, Devi Parikh, 和 Yaniv Taigman的“Make-a-scene: 基于场景的文本到图像生成，具有人类先验学习”论文。

此模型继承自PreTrainedModel。请查阅超类文档，了解库为所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、剪枝头部等）。

此模型也是PyTorch torch.nn.Module的子类。将其用作常规PyTorch模块，并查阅PyTorch文档以了解所有有关通用使用和行为的问题。

_forward_unimplemented

( *input: 任何 )

定义每次调用时执行的计算。

应该由所有子类覆盖。

尽管需要在此函数中定义前向传递的配方，但应当在调用 Module 实例之后而不是此函数中，因为前者会处理运行已注册的钩子，而后者会默默地忽略它们。

ChameleonModel

类 transformers.ChameleonModel

( config: ChameleonConfig )

参数

config (ChameleonConfig) — 包含模型所有参数的模型配置类。使用配置文件初始化不会加载模型相关的权重，只有配置。查看 from_pretrained() 方法以加载模型权重。config — ChameleonConfig

一个裸的Chameleon模型，输出原始的隐藏状态，没有顶部的特定头部。此模型继承自 PreTrainedModel。请检查通用方法的超类文档，这些方法是库为所有模型实现的（例如下载或保存、调整输入嵌入的大小、剪枝头部等）

此模型也是PyTorch torch.nn.Module的子类。将其用作常规PyTorch模块，并查阅PyTorch文档以了解所有有关通用使用和行为的问题。

由配置的 num_hidden_layers 层组成的Transformer解码器。每层都是一个 ChameleonDecoderLayer

forward

( input_ids: LongTensor = None pixel_values: FloatTensor = 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 cache_position: Optional = None ) → transformers.modeling_outputs.BaseModelOutputWithPast or tuple(torch.FloatTensor)

参数

input_ids (torch.LongTensor 形状 (batch_size, sequence_length)) — 词汇表中的输入序列标记的索引。如果提供，则默认忽略填充。
pixel_values (torch.FloatTensor 形状 `(batch_size, num_channels, image_size, image_size)`) — 与输入图像相对应的张量。像素值可以通过 AutoImageProcessor 获取。有关详细信息，请参阅 ChameleonImageProcessor.call()。
attention_mask（torch.Tensor 形状为 (batch_size, sequence_length) 的张量，可选）—— 避免在填充标记的索引上进行注意力运算的掩码。掩码值选取于 [0, 1]：《p>
- 1 表示 tokens 未被掩码，
- 0 表示 tokens 被掩码。
什么是注意力掩码？

索引可以通过使用 AutoTokenizer 获得。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。

如果使用 past_key_values，则可选只输入最后的 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] 内。《p>

什么是位置ID？
过去的键值 (Cache, 可选) — 可以用于加速顺序解码的预计算隐藏状态（自注意力块和交叉注意力块中的键和值）。这通常包含在解码的先前的阶段模型返回的 past_key_values，当 use_cache=True 或 config.use_cache=True 时。
应该始终是一个 Cache 实例，并且模型将输出相同的缓存实例。如果使用 past_key_values，则用户可以选择只输入形状为 (batch_size, 1) 的最后一个 input_ids（那些没有将过去的键值状态提供给此模型的）而不是所有形状为 (batch_size, sequence_length) 的 input_ids。
输入嵌入 (shape 为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor，可选) — 也可以选择直接传递嵌套表示，而不传递 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 而不是纯元组。
cache_position (torch.LongTensor 的形状为 (sequence_length)，可选) — 表示输入序列标记在序列中的位置的索引。与 position_ids 不同，此张量不受填充的影响。它用于更新缓存到正确的位置，并推断完整的序列长度。

返回值

transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)

一个 transformers.modeling_outputs.BaseModelOutputWithPast 或一个包含多个元素的 torch.FloatTensor 组成的元组（如果传递了参数 return_dict=False 或当 config.return_dict=False 时），这些元素取决于配置（ChameleonConfig）和输入。

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

如果使用了 past_key_values，则只输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。
past_key_values (tuple(tuple(torch.FloatTensor))，可选，在传递了参数 use_cache=True 或当 config.use_cache=True 时返回) — 长度为 config.n_layers 的 tuple(torch.FloatTensor) 组成的元组，每个元组包含两个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量，如果 config.is_encoder_decoder=True，则可选地包含两个形状为 (batch_size, num_heads, encoder_sequence_length, embed_size_per_head) 的额外张量。

包含预先计算的隐藏状态（自注意力块中的键和值以及在 config.is_encoder_decoder=True 时可选地在交叉注意力块中的）可用于（参见 past_key_values 输入）以加速顺序解码。
hidden_states (tuple(torch.FloatTensor)，可选，在传递了参数 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 包含一个形状为 (batch_size, sequence_length, hidden_size) 的 torch.FloatTensor 的元组（如果有嵌入层，则为嵌入输出的一个，加上每个层输出的一个）。

模型在每层输出的隐藏状态以及可选的初始嵌入输出。
attentions (tuple(torch.FloatTensor)，可选，在传递了参数 output_attentions=True 或当 config.output_attentions=True 时返回) — 包含形状为 (batch_size, num_heads, sequence_length, sequence_length) 的 torch.FloatTensor 的元组（每个层一个）。

注意力的权重在注意力 softmax 后，用于在自注意力头中计算加权平均。

ChameleonModel 的前进方法覆盖了特殊的 __call__ 方法。

尽管前向传递的配方需要在函数内部定义，但是应该在调用 Module 实例之后而不是这个函数上调用它，因为前者负责运行预和后处理步骤，而后者默默地忽略它们。

示例

>>> from transformers import AutoTokenizer, ChameleonModel
>>> import torch

>>> tokenizer = AutoTokenizer.from_pretrained("meta/chameleon-7b")
>>> model = ChameleonModel.from_pretrained("meta/chameleon-7b")

>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> outputs = model(**inputs)

>>> last_hidden_states = outputs.last_hidden_state

ChameleonForConditionalGeneration

类 transformers.ChameleonForConditionalGeneration

( config )

参数

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

Chameleon模型，顶部有头部用于输出下一个标记的logits。此模型继承自PreTrainedModel。检查超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝头部等。）

此模型也是PyTorch torch.nn.Module的子类。将其用作常规PyTorch模块，并查阅PyTorch文档以了解所有有关通用使用和行为的问题。

forward