Transformers 文档

Chameleon

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

Chameleon

概述

Chameleon 模型由 META AI Chameleon 团队在 Chameleon: Mixed-Modal Early-Fusion Foundation Models 中提出。 Chameleon 是一个视觉-语言模型,它使用向量量化来标记图像,使模型能够生成多模态输出。该模型以图像和文本作为输入,包括交错格式,并生成文本响应。图像生成模块尚未发布。

该论文的摘要如下

我们提出了 Chameleon,一个基于早期融合令牌的混合模态模型家族,能够理解和生成任意序列中的图像和文本。我们概述了一种从初始阶段开始的稳定训练方法、一种对齐方案以及为早期融合、基于令牌的混合模态设置量身定制的架构参数化。这些模型在一系列全面的任务中进行了评估,包括视觉问答、图像描述、文本生成、图像生成和长格式混合模态生成。Chameleon 展示了广泛而通用的能力,包括在图像描述任务中达到最先进的性能,在纯文本任务中优于 Llama-2,同时与 Mixtral 8x7B 和 Gemini-Pro 等模型具有竞争力,并且在单个模型中执行重要的图像生成。根据对新的长格式混合模态生成评估的人工判断,它在性能上也与更大的模型(包括 Gemini Pro 和 GPT-4V)相匹配或超过,其中提示或输出都包含图像和文本的混合序列。Chameleon 标志着在完全多模态文档的统一建模方面向前迈出了重要一步

drawing Chameleon 整合了一个向量量化器模块,将图像转换为离散令牌。这也使得可以使用自回归 Transformer 进行图像生成。摘自原始论文。

此模型由 joaoganteRaushanTurganbay 贡献。原始代码可以在这里找到。

使用技巧

  • 我们建议用户在计算批量生成时使用 padding_side="left",因为它能带来更准确的结果。只需确保在生成之前设置 processor.tokenizer.padding_side = "left"

  • 请注意,Chameleon 针对安全对齐进行了调整。如果模型拒绝回答,请考虑提出更具体的问题,而不是开放式问题。

  • Chameleon 以聊天格式生成,这意味着生成的文本将始终是“助手的回合”。您可以通过在调用处理器时传递 return_for_text_completion=True 来启用文本完成生成。

[!NOTE] Transformers 中的 Chameleon 实现使用特殊的图像令牌来指示在哪里合并图像嵌入。对于特殊的图像令牌,我们没有添加新的令牌,而是使用了保留令牌之一:<reserved08707>。您必须将 <image> 添加到提示中,以指示应嵌入图像的位置,以便正确生成。

使用示例

单图像推理

Chameleon 是一个门控模型,因此请确保您已使用令牌访问并登录到 Hugging Face Hub。以下是如何加载模型并以半精度 (torch.bfloat16) 执行推理的方法

from transformers import ChameleonProcessor, ChameleonForConditionalGeneration
import torch
from PIL import Image
import requests

processor = ChameleonProcessor.from_pretrained("facebook/chameleon-7b")
model = ChameleonForConditionalGeneration.from_pretrained("facebook/chameleon-7b", torch_dtype=torch.bfloat16, device_map="cuda")

# prepare image and text prompt
url = 'http://images.cocodataset.org/val2017/000000039769.jpg'
image = Image.open(requests.get(url, stream=True).raw)
prompt = "What do you see in this image?<image>"

inputs = processor(prompt, image, return_tensors="pt").to(model.device, dtype=torch.bfloat16)

# autoregressively complete prompt
output = model.generate(**inputs, max_new_tokens=50)
print(processor.decode(output[0], skip_special_tokens=True))

多图像推理

Chameleon 可以使用多个图像作为输入执行推理,其中图像可以属于同一提示或不同提示(在批量推理中)。以下是如何执行此操作的方法

from transformers import ChameleonProcessor, ChameleonForConditionalGeneration
import torch
from PIL import Image
import requests

processor = ChameleonProcessor.from_pretrained("facebook/chameleon-7b")

model = ChameleonForConditionalGeneration.from_pretrained("facebook/chameleon-7b", torch_dtype=torch.bfloat16, device_map="cuda")

# Get three different images
url = "https://www.ilankelman.org/stopsigns/australia.jpg"
image_stop = Image.open(requests.get(url, stream=True).raw)

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

url = "https://huggingface.co/microsoft/kosmos-2-patch14-224/resolve/main/snowman.jpg"
image_snowman = Image.open(requests.get(url, stream=True).raw)

# Prepare a batched prompt, where the first one is a multi-image prompt and the second is not
prompts = [
    "What do these images have in common?<image><image>",
    "<image>What is shown in this image?"
]

# We can simply feed images in the order they have to be used in the text prompt
# Each "<image>" token uses one image leaving the next for the subsequent "<image>" tokens
inputs = processor(text=prompts, images=[image_stop, image_cats, image_snowman], padding=True, return_tensors="pt").to(device="cuda", dtype=torch.bfloat16)

# Generate
generate_ids = model.generate(**inputs, max_new_tokens=50)
processor.batch_decode(generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)

模型优化

使用 Bitsandbytes 进行量化

该模型可以加载为 8 位或 4 位,大大降低了内存需求,同时保持了原始模型的性能。首先,请确保安装 bitsandbytes,pip install bitsandbytes,并有权访问库支持的 GPU/加速器。

bitsandbytes 正在被重构,以支持 CUDA 以外的多个后端。目前,ROCm (AMD GPU) 和 Intel CPU 实现已经成熟,Intel XPU 正在进行中,Apple Silicon 支持预计在 Q4/Q1 推出。有关安装说明和最新的后端更新,请访问此链接

我们重视您的反馈,以帮助在全面发布之前识别错误!请查看这些文档以获取更多详细信息和反馈链接。

只需将上面的代码片段更改为

from transformers import ChameleonForConditionalGeneration, BitsAndBytesConfig

# specify how to quantize the model
quantization_config = BitsAndBytesConfig(
    load_in_4bit=True,
    bnb_4bit_quant_type="nf4",
    bnb_4bit_compute_dtype=torch.bfloat16,
)

model = ChameleonForConditionalGeneration.from_pretrained("facebook/chameleon-7b", quantization_config=quantization_config, device_map="cuda")

使用 Flash-Attention 2 和 SDPA 进一步加速生成

这些模型同时支持 Flash-Attention 2 和 PyTorch 的 torch.nn.functional.scaled_dot_product_attention,可以启用它们进行优化。SDPA 是加载模型时的默认选项。如果要切换到 Flash Attention 2,请首先确保安装 flash-attn。有关该软件包的安装,请参阅原始存储库。只需将上面的代码片段更改为

from transformers import ChameleonForConditionalGeneration

model_id = "facebook/chameleon-7b"
model = ChameleonForConditionalGeneration.from_pretrained(
    model_id, 
    torch_dtype=torch.bfloat16, 
    low_cpu_mem_usage=True,
    attn_implementation="flash_attention_2"
).to(0)

ChameleonConfig

class transformers.ChameleonConfig

< >

( 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) — chameleon 模型的词汇表大小。定义调用 ChameleonModel 时传递的 inputs_ids 可以表示的不同令牌的数量;这包括文本和图像令牌。
  • 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 检查点时,每个组键和值头应通过对该组内所有原始头进行平均池化来构建。有关更多详细信息,请查看[本文](https://arxiv.org/pdf/2305.13245.pdf)。如果未指定,则默认为 num_attention_heads
  • hidden_act (strfunction, 可选, 默认为 "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, optional) — 填充 token id。
  • bos_token_id (int, optional, defaults to 1) — 流开始 token id。默认为 1。
  • eos_token_id (int, optional, defaults to 2) — 流结束 token id。默认为 2。
  • tie_word_embeddings (bool, optional, defaults to False) — 是否绑定词嵌入权重。默认为 False
  • rope_theta (float, optional, defaults to 10000.0) — RoPE 嵌入的基础周期。默认为 10000.0。
  • rope_scaling (Dict, optional) — 包含 RoPE 嵌入缩放配置的字典。目前支持两种缩放策略:linear 和 dynamic。它们的缩放因子必须是大于 1 的浮点数。期望的格式是 {"type": strategy name, "factor": scaling factor}。当使用此标志时,请勿将 max_position_embeddings 更新为预期的新最大值。有关这些缩放策略如何工作的更多信息,请参见以下主题: https://www.reddit.com/r/Localchameleon/comments/14mrgpr/dynamically_scaled_rope_further_increases/。这是一个实验性功能,未来版本中可能会有破坏性的 API 更改。
  • attention_bias (bool, defaults to False, optional, defaults to False) — 是否在自注意力期间在 query、key、value 和输出投影层中使用偏置。默认为 False
  • attention_dropout (float, optional, defaults to 0.0) — 注意力概率的 dropout 比率。默认为 0.0。
  • model_parallel_size (int, optional, defaults to 1) — 训练模型时使用的分片数量。这将用于 qk layernorm,因为原始的 Chameleon 推理不在这些层中进行缩减,并且每个 rank 都有自己的偏置。默认为 1。
  • swin_norm (bool, optional, defaults to False) — 是否使用 Swin Transformer 归一化。默认为 False
  • vq_config (dict, optional) — 包含 VQ-VAE 模型配置的 ChameleonVQConfig 实例。
  • vocabulary_map (dict, optional) — 包含来自 tokenizer 的词汇表映射的字典。用于从图像输入中获取 token。
  • mlp_bias (bool, optional, defaults to False) — 是否在 MLP 层中的 up_proj、down_proj 和 gate_proj 层中使用偏置。默认为 False

这是用于存储 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

class 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, optional, defaults to 256) — 每个嵌入向量的维度。默认为 256。
  • num_embeddings (int, optional, defaults to 8192) — 代码本嵌入的数量。默认为 8192。
  • double_latent (bool, optional, defaults to False) — 是否使用双 z 通道。默认为 False
  • latent_channels (int, optional, defaults to 256) — 潜在空间的通道数。默认为 256。
  • resolution (int, optional, defaults to 512) — 输入图像的分辨率。默认为 512。
  • in_channels (int, optional, defaults to 3) — 输入通道数。默认为 3。
  • base_channels (int, optional, defaults to 128) — 基础通道计数。默认为 128。
  • channel_multiplier (List[int], optional, defaults to [1, 1, 2, 2, 4]) — 每个分辨率的通道乘数。默认为 [1, 1, 2, 2, 4]
  • num_res_blocks (int, optional, defaults to 2) — 残差块的数量。默认为 2。
  • attn_resolutions (List[int], optional) — 应用注意力的分辨率。
  • dropout (float, optional, defaults to 0.0) — Dropout 率。默认为 0.0。
  • attn_type (str, optional, defaults to "vanilla") — VQ-GAN 编码器中使用的注意力类型。可以是 “vanilla” 或 None。默认为 “vanilla”。
  • initializer_range (float, optional, defaults to 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。默认为 0.02。

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

ChameleonProcessor

class transformers.ChameleonProcessor

< >

( image_processor tokenizer image_seq_length: int = 1024 image_token: str = '<image>' )

参数

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

构建一个 Chameleon 处理器,该处理器将 Chameleon 图像处理器和 Chameleon 分词器包装到单个处理器中。

ChameleonProcessor 提供了 ChameleonImageProcessorLlamaTokenizerFast 的所有功能。有关更多信息,请参阅 __call__()decode()

batch_decode

< >

( *args **kwargs )

此方法将其所有参数转发到 LlamaTokenizerFast 的 batch_decode()。有关更多信息,请参阅此方法的文档字符串。

decode

< >

( *args **kwargs )

此方法将其所有参数转发到 LlamaTokenizerFast 的 decode()。有关更多信息,请参阅此方法的文档字符串。

ChameleonImageProcessor

class 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}): 调整大小后图像的尺寸。图像的最短边调整为 size[“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 (intfloat, 可选, 默认为 0.0078) — 如果缩放图像,则使用的缩放因子。可以被 preprocess 方法中的 rescale_factor 覆盖。
  • do_normalize (bool, 可选, 默认为 True) — 是否对图像进行归一化。可以被 preprocess 方法中的 do_normalize 覆盖。
  • image_mean (floatList[float], 可选, 默认为 [1.0, 1.0, 1.0]) — 如果对图像进行归一化,则使用的均值。这是一个浮点数或浮点数列表,其长度等于图像中通道的数量。可以被 preprocess 方法中的 image_mean 参数覆盖。
  • image_std (floatList[float], 可选, 默认为 [1.0, 1.0, 1.0]) — 如果对图像进行归一化,则使用的标准差。这是一个浮点数或浮点数列表,其长度等于图像中通道的数量。可以被 preprocess 方法中的 image_std 参数覆盖。可以被 preprocess 方法中的 image_std 参数覆盖。
  • do_convert_rgb (bool, 可选, 默认为 True) — 是否将图像转换为 RGB 格式。

构建一个 Chameleon 图像处理器。

preprocess

< >

( images: Union do_resize: bool = None size: Dict = None resample: Resampling = None do_center_crop: bool = None crop_size: int = None do_rescale: bool = None rescale_factor: float = None do_normalize: bool = None image_mean: Union = None image_std: Union = None do_convert_rgb: bool = None return_tensors: Union = None data_format: Optional = <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) — 调整大小后图像的尺寸。图像的最短边调整为 size[“shortest_edge”],最长边调整为保持输入宽高比。
  • resample (int, optional, defaults to self.resample) — 如果调整图像大小,则使用的重采样过滤器。可以是枚举类型 PILImageResampling 之一。仅当 do_resize 设置为 True 时有效。
  • do_center_crop (bool, optional, defaults to self.do_center_crop) — 是否对图像进行中心裁剪。
  • crop_size (Dict[str, int], optional, defaults to self.crop_size) — 中心裁剪的尺寸。仅当 do_center_crop 设置为 True 时有效。
  • do_rescale (bool, optional, defaults to self.do_rescale) — 是否对图像进行缩放。
  • rescale_factor (float, optional, defaults to self.rescale_factor) — 如果 do_rescale 设置为 True,则图像的缩放因子。
  • do_normalize (bool, optional, defaults to self.do_normalize) — 是否对图像进行归一化。
  • image_mean (float or List[float], optional, defaults to self.image_mean) — 用于归一化的图像均值。仅当 do_normalize 设置为 True 时有效。
  • image_std (float or List[float], optional, defaults to self.image_std) — 用于归一化的图像标准差。仅当 do_normalize 设置为 True 时有效。
  • do_convert_rgb (bool, optional, defaults to self.do_convert_rgb) — 是否将图像转换为 RGB 格式。
  • return_tensors (str or TensorType, optional) — 返回的张量类型。可以是以下之一:
    • Unset: 返回 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 or str, optional, defaults to ChannelDimension.FIRST) — 输出图像的通道维度格式。可以是以下之一:
    • "channels_first"ChannelDimension.FIRST:图像格式为 (num_channels, height, width)。
    • "channels_last"ChannelDimension.LAST:图像格式为 (height, width, num_channels)。
    • Unset: 使用输入图像的通道维度格式。
  • input_data_format (ChannelDimension or str, optional) — 输入图像的通道维度格式。如果未设置,则从输入图像推断通道维度格式。可以是以下之一:
    • "channels_first"ChannelDimension.FIRST:图像格式为 (num_channels, height, width)。
    • "channels_last"ChannelDimension.LAST:图像格式为 (height, width, num_channels)。
    • "none"ChannelDimension.NONE:图像格式为 (height, width)。

预处理单张或批量图像。

ChameleonVQVAE

class transformers.ChameleonVQVAE

< >

( config: ChameleonVQVAEConfig )

参数

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

在 Chameleon 中使用的 VQ-VAE 模型,用于将图像编码/解码为离散 tokens。此模型遵循 Oran Gafni, Adam Polyak, Oron Ashual, Shelly Sheynin, Devi Parikh 和 Yaniv Taigman 的论文 “Make-a-scene: Scene-based text-to-image generation with human priors”。

此模型继承自 PreTrainedModel。查看超类文档以获取库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、剪枝头等)。

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

_forward_unimplemented

< >

( *input: Any )

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

应由所有子类重写。

尽管 forward 传递的配方需要在该函数内定义,但应在此之后调用 Module 实例,而不是调用此函数,因为前者负责运行注册的钩子,而后者会静默地忽略它们。

ChameleonModel

class transformers.ChameleonModel

< >

( config: ChameleonConfig )

参数

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

裸机 chameleon 模型,输出原始隐藏状态,顶部没有任何特定的 head。此模型继承自 PreTrainedModel。查看超类文档以获取库为所有模型实现的通用方法(例如下载或保存、调整输入嵌入大小、剪枝头等)。

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

Transformer 解码器,由 config.num_hidden_layers 层组成。每层都是一个 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.BaseModelOutputWithPasttuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor,形状为 (batch_size, sequence_length)) — 输入序列 tokens 在词汇表中的索引。如果您提供 padding,默认情况下 padding 将被忽略。

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

    什么是输入 IDs?

  • pixel_values (torch.FloatTensor,形状为 `(batch_size, num_channels, image_size, image_size)`) — 对应输入图像的张量。像素值可以使用 AutoImageProcessor 获得。有关详细信息,请参阅 ChameleonImageProcessor.call()
  • attention_mask (torch.Tensor,形状为 (batch_size, sequence_length)可选) — 用于避免在 padding token 索引上执行 attention 的掩码。掩码值在 [0, 1] 中选择:

    • 1 表示 token 未被掩盖
    • 0 表示 token 被掩盖

    什么是 attention 掩码?

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

    如果使用 past_key_values,则可以选择仅输入最后的 input_ids(请参阅 past_key_values)。

    如果要更改 padding 行为,应阅读 modeling_opt._prepare_decoder_attention_mask 并根据您的需要进行修改。有关默认策略的更多信息,请参阅 论文 中的图 1。

    • 1 表示 head 未被掩盖
    • 0 表示 head 被掩盖
  • position_ids (torch.LongTensor,形状为 (batch_size, sequence_length)可选) — 位置嵌入中每个输入序列 token 的位置索引。在范围 [0, config.n_positions - 1] 中选择。

    什么是位置 ID?

  • past_key_values (Cache可选) — 预先计算的隐藏状态(自注意力模块和交叉注意力模块中的键和值),可用于加速顺序解码。这通常包括模型在先前解码阶段返回的 past_key_values,当 use_cache=Trueconfig.use_cache=True 时。

    应始终为 Cache 实例,并且模型将输出相同的 cache 实例。如果使用 past_key_values,则用户可以选择仅输入最后的 input_ids(那些没有将其 past key value 状态提供给此模型的 input_ids),形状为 (batch_size, 1),而不是形状为 (batch_size, sequence_length) 的所有 input_ids

  • inputs_embeds (torch.FloatTensor,形状为 (batch_size, sequence_length, hidden_size)可选) — (可选)您可以选择直接传递嵌入表示,而不是传递 input_ids。如果您希望比模型的内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联向量,这将非常有用。
  • use_cache (bool可选) — 如果设置为 True,则返回 past_key_values 键值状态,并且可以用于加速解码(请参阅 past_key_values)。
  • output_attentions (bool可选) — 是否返回所有 attention 层的 attention 张量。 有关更多详细信息,请参见返回张量下的 attentions
  • output_hidden_states (bool可选) — 是否返回所有层的隐藏状态。 有关更多详细信息,请参见返回张量下的 hidden_states
  • return_dict (bool可选) — 是否返回 ModelOutput 而不是普通元组。
  • cache_position (torch.LongTensor,形状为 (sequence_length)可选) — 描述输入序列 token 在序列中位置的索引。与 position_ids 相反,此张量不受 padding 的影响。它用于在正确的位置更新 cache 并推断完整的序列长度。

返回

transformers.modeling_outputs.BaseModelOutputWithPasttuple(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_layerstuple(tuple(torch.FloatTensor)) 元组,每个元组具有 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量,并且可选地,如果 config.is_encoder_decoder=True,则还有 2 个形状为 (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 时返回) — torch.FloatTensor 元组(如果模型具有嵌入层,则为嵌入输出,+ 每个层的输出一个),形状为 (batch_size, sequence_length, hidden_size)

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

  • attentions (tuple(torch.FloatTensor)可选,当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组(每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

ChameleonModel forward 方法,覆盖了 __call__ 特殊方法。

尽管 forward 传递的配方需要在该函数中定义,但应该在之后调用 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

class transformers.ChameleonForConditionalGeneration

< >

( config )

参数

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

Chameleon 模型,顶部带有一个 head,用于输出下一个 token 预测的 logits。此模型继承自 PreTrainedModel。查看超类文档,了解库为其所有模型实现的通用方法(例如,下载或保存、调整输入嵌入大小、剪枝 head 等)。

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

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 labels: 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.CausalLMOutputWithPasttuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor,形状为 (batch_size, sequence_length)) — 词汇表中输入序列 token 的索引。默认情况下,如果您提供 padding,则 padding 将被忽略。

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

    什么是输入 ID?

  • pixel_values (torch.FloatTensor,形状为 `(batch_size, num_channels, image_size, image_size)`) — 对应输入图像的张量。像素值可以使用 AutoImageProcessor 获得。有关详细信息,请参阅 ChameleonImageProcessor.call()
  • attention_mask (torch.Tensor,形状为 (batch_size, sequence_length)可选) — 用于避免在 padding token 索引上执行 attention 的掩码。掩码值在 [0, 1] 中选择:

    • 1 表示 token 未被掩盖
    • 0 表示 token 被掩盖

    什么是 attention 掩码?

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

    如果使用 past_key_values,则可以选择仅输入最后的 input_ids(请参阅 past_key_values)。

    如果要更改 padding 行为,应阅读 modeling_opt._prepare_decoder_attention_mask 并根据您的需要进行修改。有关默认策略的更多信息,请参阅 论文 中的图 1。

    • 1 表示 head 未被掩盖
    • 0 表示 head 被掩盖
  • position_ids (torch.LongTensor,形状为 (batch_size, sequence_length)可选) — 位置嵌入中每个输入序列 token 的位置索引。在范围 [0, config.n_positions - 1] 中选择。

    什么是位置 ID?

  • past_key_values (Cache可选) — 预先计算的隐藏状态(自注意力模块和交叉注意力模块中的键和值),可用于加速顺序解码。这通常包括模型在先前解码阶段返回的 past_key_values,当 use_cache=Trueconfig.use_cache=True 时。

    应始终为 Cache 实例,并且模型将输出相同的 cache 实例。如果使用 past_key_values,则用户可以选择仅输入最后的 input_ids(那些没有将其 past key value 状态提供给此模型的 input_ids),形状为 (batch_size, 1),而不是形状为 (batch_size, sequence_length) 的所有 input_ids

  • inputs_embeds (torch.FloatTensor,形状为 (batch_size, sequence_length, hidden_size)可选) — (可选)您可以选择直接传递嵌入表示,而不是传递 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)可选) — 索引描述输入序列 tokens 在序列中的位置。 与 position_ids 相反,此张量不受 padding 的影响。 它用于在正确的位置更新缓存并推断完整序列长度。

    Args — labels (torch.LongTensor,形状为 (batch_size, sequence_length),*可选*): 用于计算 masked language modeling 损失的标签。 索引应在 [0, ..., config.vocab_size] 或 -100 中 (参见 input_ids 文档字符串)。 索引设置为 -100 的 tokens 将被忽略 (masked),损失仅针对标签在 [0, ..., config.vocab_size] 中的 tokens 计算。

返回

transformers.modeling_outputs.CausalLMOutputWithPasttuple(torch.FloatTensor)

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

  • loss (torch.FloatTensor,形状为 (1,)可选,当提供 labels 时返回) — 语言建模损失 (用于预测下一个 token)。

  • logits (torch.FloatTensor,形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数 (SoftMax 之前每个词汇 token 的分数)。

  • past_key_values (tuple(tuple(torch.FloatTensor)),*可选*,当传递 use_cache=True 或当 config.use_cache=True 时返回) — tuple(tuple(torch.FloatTensor)) 元组,长度为 config.n_layers,每个元组包含 2 个形状为 (batch_size, num_heads, sequence_length, embed_size_per_head) 的张量)

    包含预先计算的隐藏状态 (自注意力模块中的键和值),这些状态可以用于 (参见 past_key_values 输入) 加速顺序解码。

  • 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)可选,当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — torch.FloatTensor 元组(每层一个),形状为 (batch_size, num_heads, sequence_length, sequence_length)

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

The ChameleonForConditionalGeneration 的 forward 方法,覆盖了 __call__ 特殊方法。

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

示例

>>> from transformers import ChameleonProcessor, ChameleonForConditionalGeneration
>>> import torch
>>> import requests
>>> from PIL import Image

>>> model = ChameleonForConditionalGeneration.from_pretrained("facebook/chameleon-7b", torch_dtype=torch.bfloat16)
>>> processor = ChameleonProcessor.from_pretrained("facebook/chameleon-7b")

>>> prompt = "I used to know a lot about constellations when I was younger, but as I grew older, I forgot most of what I knew. These are the only two constellations that I really remember now.<image><image>I would like for you to tell me about 3 more constellations and give me a little bit of history about the constellation."
>>> image = Image.open(requests.get("https://nineplanets.org/wp-content/uploads/2020/12/the-big-dipper-1.jpg", stream=True).raw)
>>> image_2 = Image.open(requests.get("https://www.kxan.com/wp-content/uploads/sites/40/2020/10/ORION.jpg", stream=True).raw)

>>> inputs = processor(prompt, images=[image, image_2], return_tensors="pt").to(model.device, torch.bfloat16)

>>> generated_ids = model.generate(**inputs, max_new_tokens=100, do_sample=False)
>>> processor.batch_decode(generated_ids, skip_special_tokens=True)[0]
< > GitHub 上更新