Transformers 文档
艾莉亚 (Aria)
并获取增强的文档体验
开始使用
艾莉亚 (Aria)
概述
Aria 模型由 Rhymes.AI 团队的 Li 等人在 Aria: An Open Multimodal Native Mixture-of-Experts Model 中提出。
Aria 是一个开放的多模态原生模型，在各种多模态、语言和编码任务中都具有一流的性能。它采用混合专家架构，每个视觉标记和文本标记分别激活 3.9B 和 3.5B 参数。
论文摘要如下：
信息以多种模态呈现。多模态原生 AI 模型对于整合真实世界的信息并提供全面的理解至关重要。虽然存在专有的多模态原生模型，但它们的不开放性为采用设置了障碍，更不用说适配了。为了填补这一空白，我们推出了 Aria，一个开放的多模态原生模型，在各种多模态、语言和编码任务中都具有一流的性能。Aria 是一个混合专家模型，每个视觉标记和文本标记分别激活 3.9B 和 3.5B 参数。在各种多模态任务中，它优于 Pixtral-12B 和 Llama3.2-11B，并且与最好的专有模型相媲美。我们遵循 4 阶段的流水线从头开始预训练 Aria，逐步为模型配备强大的语言理解、多模态理解、长上下文窗口和指令跟随能力。我们开源了模型权重以及代码库，以方便 Aria 在实际应用中的轻松采用和适配。
使用技巧
以下是如何将模型用于视觉任务的方法
import requests
import torch
from PIL import Image
from transformers import AriaProcessor, AriaForConditionalGeneration
model_id_or_path = "rhymes-ai/Aria"
model = AriaForConditionalGeneration.from_pretrained(
model_id_or_path, device_map="auto"
)
processor = AriaProcessor.from_pretrained(model_id_or_path)
image = Image.open(requests.get("http://images.cocodataset.org/val2017/000000039769.jpg", stream=True).raw)
messages = [
{
"role": "user",
"content": [
{"type": "image"},
{"text": "what is the image?", "type": "text"},
],
}
]
text = processor.apply_chat_template(messages, add_generation_prompt=True)
inputs = processor(text=text, images=image, return_tensors="pt")
inputs.to(model.device)
output = model.generate(
**inputs,
max_new_tokens=15,
stop_strings=["<|im_end|>"],
tokenizer=processor.tokenizer,
do_sample=True,
temperature=0.9,
)
output_ids = output[0][inputs["input_ids"].shape[1]:]
response = processor.decode(output_ids, skip_special_tokens=True)AriaImageProcessor
class transformers.AriaImageProcessor
< 源代码 >( image_mean: typing.List[float] = None image_std: typing.List[float] = None max_image_size: int = 980 min_image_size: int = 336 split_resolutions: typing.Optional[typing.List[typing.Tuple[int, int]]] = None split_image: typing.Optional[bool] = False do_convert_rgb: typing.Optional[bool] = True do_normalize: typing.Optional[bool] = True resample: Resampling = <Resampling.BICUBIC: 3> **kwargs )
参数
- image_mean (
list, 可选, 默认为 [0.5, 0.5, 0.5]) — 归一化的均值。 - image_std (
list, 可选, 默认为 [0.5, 0.5, 0.5]) — 归一化的标准差值。 - max_image_size (
int, 可选, 默认为 980) — 最大图像尺寸。 - min_image_size (
int, 可选, 默认为 336) — 最小图像尺寸。 - split_resolutions (
list, 可选, 默认为最佳分辨率元组列表) — 用于分割图像的最佳分辨率。 - split_image (
bool, 可选, 默认为False) — 是否分割图像。 - do_convert_rgb (
bool, optional, defaults toTrue) — 是否将图像转换为 RGB 格式。 - do_normalize (
bool, optional, defaults toTrue) — 是否对图像进行归一化。 - resample (PILImageResampling, optional, defaults to
BICUBIC) — 如果调整图像大小，则使用的重采样滤波器。
用于 Aria 模型的视觉处理器，处理图像预处理。初始化 AriaImageProcessor。
get_image_patches
< source >( image: <built-in function array> grid_pinpoints: typing.List[typing.Tuple[int, int]] patch_size: int resample: Resampling data_format: ChannelDimension input_data_format: ChannelDimension ) → List[np.array]
参数
- image (
np.array) — 要处理的输入图像。 - grid_pinpoints (List[Tuple[int, int]]) — 可能分辨率的元组列表。
- patch_size (
int) — 将图像分割成的图块大小。 - resample (
PILImageResampling) — 如果调整图像大小，则使用的重采样滤波器。 - data_format (
ChannelDimensionorstr) — 输出图像的通道维度格式。 - input_data_format (
ChannelDimensionorstr) — 输入图像的通道维度格式。
Returns
List[np.array]
包含已处理图像图块的 NumPy 数组列表。
通过将图像划分为图块来处理具有可变分辨率的图像。
pad
< source >( image: ndarray padding: typing.Union[int, typing.Tuple[int, int], typing.Iterable[typing.Tuple[int, int]]] mode: PaddingMode = <PaddingMode.CONSTANT: 'constant'> constant_values: typing.Union[float, typing.Iterable[float]] = 0.0 data_format: typing.Union[str, transformers.image_utils.ChannelDimension, NoneType] = None input_data_format: typing.Union[str, transformers.image_utils.ChannelDimension, NoneType] = None ) → np.ndarray
参数
- image (
np.ndarray) — 要填充的图像。 - padding (
intorTuple[int, int]orIterable[Tuple[int, int]]) — 应用于高度、宽度轴边缘的填充。可以是以下三种格式之一：((before_height, after_height), (before_width, after_width))每个轴的独特填充宽度。((before, after),)为高度和宽度产生相同的之前和之后填充。(pad,)或 int 是所有轴之前 = 之后 = 填充宽度的快捷方式。
- mode (
PaddingMode) — 要使用的填充模式。可以是以下之一："constant": 用常数值填充。"reflect": 用向量的反射填充，该反射在向量的第一个和最后一个值上沿每个轴镜像。"replicate": 用阵列边缘上最后一个值的复制填充，沿每个轴。"symmetric": 用向量的反射填充，该反射沿阵列的边缘镜像。
- constant_values (
floatorIterable[float], optional) — 如果mode为"constant"，则用于填充的值。 - data_format (
strorChannelDimension, optional) — 输出图像的通道维度格式。可以是以下之一："channels_first"或ChannelDimension.FIRST：图像格式为 (num_channels, height, width)。"channels_last"或ChannelDimension.LAST：图像格式为 (height, width, num_channels)。如果未设置，将使用与输入图像相同的格式。
- input_data_format (
strorChannelDimension, optional) — 输入图像的通道维度格式。可以是以下之一："channels_first"或ChannelDimension.FIRST：图像格式为 (num_channels, height, width)。"channels_last"或ChannelDimension.LAST：图像格式为 (height, width, num_channels)。如果未设置，将使用输入图像的推断格式。
Returns
np.ndarray
填充后的图像。
使用指定的 padding 和 mode 填充 image。填充可以在 (height, width) 维度或 (num_patches) 维度中进行。在第二种情况下，应将元组的可迭代对象作为输入。
preprocess
< source >( images: typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor'], typing.List[typing.Union[ForwardRef('PIL.Image.Image'), numpy.ndarray, ForwardRef('torch.Tensor'), list['PIL.Image.Image'], list[numpy.ndarray], list['torch.Tensor']]]] image_mean: typing.Union[float, typing.List[float], NoneType] = None image_std: typing.Union[float, typing.List[float], NoneType] = None max_image_size: typing.Optional[int] = None min_image_size: typing.Optional[int] = None split_image: typing.Optional[bool] = None do_convert_rgb: typing.Optional[bool] = None do_normalize: typing.Optional[bool] = None resample: Resampling = None return_tensors: typing.Union[str, transformers.utils.generic.TensorType, NoneType] = 'pt' data_format: typing.Optional[transformers.image_utils.ChannelDimension] = <ChannelDimension.FIRST: 'channels_first'> input_data_format: typing.Union[str, transformers.image_utils.ChannelDimension, NoneType] = None ) → BatchFeature
参数
- images (ImageInput or list of ImageInput) — 输入图像或图像列表。
- image_mean (
list, optional, defaults to [0.5, 0.5, 0.5]) — 归一化的均值。 - image_std (
list, optional, defaults to [0.5, 0.5, 0.5]) — 归一化的标准差值。 - max_image_size (
int, optional, defaults toself.max_image_size(980)) — 最大图像尺寸。 - min_image_size (
int, optional, defaults toself.min_image_size(336)) — 最小图像尺寸。 - split_image (
bool, 可选, 默认为self.split_image(False)) — 是否分割图像。 - do_convert_rgb (
bool, 可选, 默认为self.do_convert_rgb(True)) — 是否将图像转换为 RGB 格式。 - do_normalize (
bool, 可选, 默认为self.do_normalize(True)) — 是否标准化图像。 - resample (PILImageResampling, 可选, 默认为
self.resample(BICUBIC)) — 如果调整图像大小，则使用的重采样过滤器。 - return_tensors (
str或TensorType, 可选, 默认为 “pt”) — 返回的张量类型。 - data_format (
str或ChannelDimension, 可选) — 输出图像的通道维度格式。 可以是以下之一："channels_first"或ChannelDimension.FIRST：图像格式为 (num_channels, height, width)。"channels_last"或ChannelDimension.LAST：图像格式为 (height, width, num_channels)。 如果未设置，将使用与输入图像相同的格式。
- input_data_format (
str或ChannelDimension, 可选) — 输入图像的通道维度格式。 可以是以下之一："channels_first"或ChannelDimension.FIRST：图像格式为 (num_channels, height, width)。"channels_last"或ChannelDimension.LAST：图像格式为 (height, width, num_channels)。 如果未设置，将使用输入图像的推断格式。
Returns
BatchFeature
包含 BatchFeature 对象的
- ‘pixel_values’：已处理图像像素值的张量。
- ‘pixel_mask’：布尔像素掩码。 此掩码是形状为 (max_image_size, max_image_size) 的 2D 张量，其中
- True (1) 值表示属于原始调整大小图像的像素。
- False (0) 值表示属于填充部分的像素。 该掩码有助于区分后续处理步骤中的实际图像内容和填充区域。
- ‘num_crops’：所有图像中裁剪的最大数量。
处理图像列表。
AriaProcessor
class transformers.AriaProcessor
< source >( image_processor = None tokenizer: typing.Union[transformers.models.auto.tokenization_auto.AutoTokenizer, str] = None chat_template: typing.Optional[str] = None size_conversion: typing.Optional[typing.Dict[typing.Union[float, int], int]] = None )
参数
- image_processor (
AriaImageProcessor, 可选) — 用于图像预处理的 AriaImageProcessor。 - tokenizer (
PreTrainedTokenizerBase, 可选) — PreTrainedTokenizerBase 的实例。 这应该与模型的文本模型相对应。 tokenizer 是必需的输入。 - chat_template (
str, 可选) — Jinja 模板，将用于将聊天中的消息列表转换为可标记化的字符串。 - size_conversion (
Dict, 可选) — 指示图像尺寸转换的字典。
AriaProcessor 是 Aria 模型的处理器，它包装了 Aria 图像预处理器和 LLama slow tokenizer。
此方法将其所有参数转发到 LlamaTokenizerFast 的 batch_decode()。 有关更多信息，请参阅此方法的文档字符串。
此方法将其所有参数转发到 LlamaTokenizerFast 的 decode()。 有关更多信息，请参阅此方法的文档字符串。
AriaTextConfig
class transformers.AriaTextConfig
< source >( vocab_size = 32000 hidden_size = 4096 intermediate_size: int = 4096 num_hidden_layers = 32 num_attention_heads = 32 num_key_value_heads = None hidden_act = 'silu' max_position_embeddings = 2048 initializer_range = 0.02 rms_norm_eps = 1e-06 use_cache = True pad_token_id = 2 bos_token_id = 1 eos_token_id = 2 pretraining_tp = 1 tie_word_embeddings = False rope_theta = 10000.0 rope_scaling = None attention_bias = False attention_dropout = 0.0 mlp_bias = False head_dim = None moe_num_experts: int = 8 moe_topk: int = 2 moe_num_shared_experts: int = 2 **kwargs )
参数
- vocab_size (
int, 可选, 默认为 32000) — LLaMA 模型的词汇表大小。 定义调用 LlamaModel 时传递的inputs_ids可以表示的不同 token 的数量 - hidden_size (
int, 可选, 默认为 4096) — 隐藏层表示的维度。 - intermediate_size (
int, 可选, 默认为 4096) — MLP 表示的大小。 - num_hidden_layers (
int, 可选, 默认为 32) — Transformer 解码器中隐藏层的数量。 - num_attention_heads (
int, 可选, 默认为 32) — Transformer 解码器中每个注意力层的注意力头数。 - num_key_value_heads (
int, 可选) — 这是用于实现分组查询注意力（Grouped Query Attention）的 key_value 头的数量。如果num_key_value_heads=num_attention_heads，模型将使用多头注意力（Multi Head Attention，MHA）；如果num_key_value_heads=1，模型将使用多查询注意力（Multi Query Attention，MQA）；否则，将使用 GQA。当将多头检查点转换为 GQA 检查点时，每个组的 key 和 value 头应通过对该组内所有原始头进行平均池化来构建。有关更多详细信息，请查看这篇论文。如果未指定，则默认为num_attention_heads。 - hidden_act (
str或function, 可选, 默认为"silu") — 解码器中的非线性激活函数（函数或字符串）。 - max_position_embeddings (
int, 可选, 默认为 2048) — 此模型可能使用的最大序列长度。 Llama 1 支持最多 2048 个 token，Llama 2 支持最多 4096 个，CodeLlama 支持最多 16384 个。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的截断正态分布初始化器的标准差。 - rms_norm_eps (
float, 可选, 默认为 1e-06) — rms 归一化层使用的 epsilon 值。 - use_cache (
bool, 可选, 默认为True) — 模型是否应返回最后的键/值注意力（并非所有模型都使用）。仅当config.is_decoder=True时相关。 - pad_token_id (
int, 可选, 默认为 2) — 填充 token id。 - bos_token_id (
int, 可选, 默认为 1) — 流开始 token id。 - eos_token_id (
int, 可选, 默认为 2) — 流结束 token id。 - pretraining_tp (
int, 可选, 默认为 1) — 实验性功能。预训练期间使用的张量并行等级。请参考此文档以了解更多信息。此值对于确保预训练结果的完全可重复性是必要的。请参考此 issue。 - tie_word_embeddings (
bool, 可选, 默认为False) — 是否绑定权重 embedding - rope_theta (
float, 可选, 默认为 10000.0) — RoPE embeddings 的基周期。 - rope_scaling (
Dict, 可选) — 包含 RoPE embeddings 缩放配置的字典。注意：如果您应用新的 rope 类型，并期望模型在更长的max_position_embeddings上工作，我们建议您相应地更新此值。预期内容：rope_type(str): 要使用的 RoPE 的子变体。可以是 [‘default’, ‘linear’, ‘dynamic’, ‘yarn’, ‘longrope’, ‘llama3’] 之一，其中 ‘default’ 是原始 RoPE 实现。factor(float, 可选): 与 ‘default’ 以外的所有 rope 类型一起使用。应用于 RoPE embeddings 的缩放因子。在大多数缩放类型中，因子 x 将使模型能够处理长度为 x * 原始最大预训练长度的序列。original_max_position_embeddings(int, 可选): 与 ‘dynamic’, ‘longrope’ 和 ‘llama3’ 一起使用。预训练期间使用的原始最大位置 embeddings。attention_factor(float, 可选): 与 ‘yarn’ 和 ‘longrope’ 一起使用。应用于注意力计算的缩放因子。如果未指定，则默认为实现建议的值，使用factor字段推断建议值。beta_fast(float, 可选): 仅与 ‘yarn’ 一起使用。用于设置线性斜坡函数中外推（仅限）边界的参数。如果未指定，则默认为 32。beta_slow(float, 可选): 仅与 ‘yarn’ 一起使用。用于设置线性斜坡函数中内插（仅限）边界的参数。如果未指定，则默认为 1。short_factor(List[float], 可选): 仅与 ‘longrope’ 一起使用。应用于短上下文（<original_max_position_embeddings）的缩放因子。必须是数字列表，其长度与隐藏层大小除以注意力头数再除以 2 相同。long_factor(List[float], 可选): 仅与 ‘longrope’ 一起使用。应用于长上下文（<original_max_position_embeddings）的缩放因子。必须是数字列表，其长度与隐藏层大小除以注意力头数再除以 2 相同。low_freq_factor(float, 可选): 仅与 ‘llama3’ 一起使用。应用于 RoPE 低频分量的缩放因子。high_freq_factor(float, 可选): 仅与 ‘llama3’ 一起使用。应用于 RoPE 高频分量的缩放因子。 - attention_bias (
bool, 可选, 默认为False) — 在自注意力期间，是否在 query、key、value 和 output 投影层中使用 bias。 - attention_dropout (
float, 可选, 默认为 0.0) — 注意力概率的 dropout 比率。 - mlp_bias (
bool, 可选, 默认为False) — 是否在 MLP 层中的 up_proj、down_proj 和 gate_proj 层中使用 bias。 - head_dim (
int, 可选) — 注意力头的维度。如果为 None，则默认为 hidden_size // num_heads - moe_num_experts (
int, 可选, 默认为 8) — MoE 层中的专家数量。 - moe_topk (
int, 可选, 默认为 2) — 每个 token 要路由到的顶部专家的数量。 - moe_num_shared_experts (
int, 可选, 默认为 2) — 共享专家的数量。
此类处理 Aria 模型文本组件的配置。使用默认值实例化配置将产生与 Aria rhymes-ai/Aria 架构模型类似的配置。此类扩展了 LlamaConfig 以包含特定于专家混合（Mixture of Experts，MoE）架构的附加参数。
AriaConfig
class transformers.AriaConfig
< source >( vision_config = None vision_feature_layer: int = -1 text_config: AriaTextConfig = None projector_patch_to_query_dict: typing.Dict = None image_token_index: int = 9 initializer_range: float = 0.02 **kwargs )
参数
- vision_config (
AriaVisionConfig或dict, 可选) — 视觉组件的配置。 - vision_feature_layer (
int, 可选, 默认为 -1) — 用于选择视觉特征的层的索引。 - text_config (
AriaTextConfig或dict, 可选) — 文本组件的配置。 - projector_patch_to_query_dict (
dict, 可选) — patch 大小到 query 维度的映射。 - image_token_index (
int, 可选, 默认为 9) — 用于表示图像 token 的索引。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的截断正态分布初始化器的标准差。 - model_type (
str) — 模型的类型，设置为"aria"。 - image_token_index (
int) — 用于表示图像 tokens 的索引。 - projector_patch_to_query_dict (
dict) — patch 大小到 query 维度的映射。 - vision_config (
AriaVisionConfig) — vision 组件的配置。 - text_config (
AriaTextConfig) — text 组件的配置。
此类处理 Aria 模型的 vision 和 text 组件的配置，以及用于图像 token 处理和投影器映射的附加参数。使用默认值实例化配置将产生与 Aria rhymes-ai/Aria 架构模型类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请阅读 PretrainedConfig 的文档。
AriaTextModel
class transformers.AriaTextModel
< source >( config: AriaTextConfig )
参数
- config (AriaTextConfig) — 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
- config — AriaTextConfig
裸 AriaText 模型，输出原始隐藏状态，顶部没有任何特定的 head。此模型继承自 PreTrainedModel。查看超类文档，了解库为其所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。
Transformer 解码器，由 config.num_hidden_layers 层组成。每一层都是一个 AriaTextDecoderLayer
forward
< source >( input_ids: LongTensor = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[transformers.cache_utils.Cache] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None **flash_attn_kwargs: typing_extensions.Unpack[transformers.modeling_flash_attention_utils.FlashAttentionKwargs] )
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor) — 词汇表中输入序列 tokens 的索引。如果您提供 padding，默认情况下将被忽略。索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- attention_mask (形状为
(batch_size, sequence_length)的torch.Tensor, 可选) — Mask 以避免在 padding token 索引上执行 attention。 Mask 值在[0, 1]中选择：- 1 代表 未被 mask 的 tokens，
- 0 代表 已被 mask 的 tokens。
索引可以使用 AutoTokenizer 获得。 有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
如果使用
past_key_values，则可以选择仅输入最后的input_ids（请参阅past_key_values）。如果您想更改 padding 行为，您应该阅读
modeling_opt._prepare_decoder_attention_mask并根据您的需求进行修改。 有关默认策略的更多信息，请参阅 论文 中的图 1。- 1 表示 head 未被 mask，
- 0 表示 head 已被 mask。
- position_ids (形状为
(batch_size, sequence_length)的torch.LongTensor, 可选) — 位置嵌入中每个输入序列 tokens 的位置索引。在[0, config.n_positions - 1]范围内选择。 - past_key_values (
Cache或tuple(tuple(torch.FloatTensor)), 可选) — 预先计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），可用于加速顺序解码。这通常包括模型在先前解码阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为
config.n_layers的tuple(torch.FloatTensor)元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。 这也称为旧版缓存格式。
模型将输出与作为输入提供的缓存格式相同的缓存格式。 如果未传递
past_key_values，则将返回旧版缓存格式。如果使用
past_key_values，用户可以选择仅输入最后的input_ids（那些没有将其过去的键值状态提供给此模型的）形状为(batch_size, 1)，而不是所有形状为(batch_size, sequence_length)的input_ids。 - inputs_embeds (形状为
(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, 可选) — 是否返回所有 attention 层的 attentions 张量。 有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (形状为
(sequence_length)的torch.LongTensor, 可选) — 描述输入序列 tokens 在序列中位置的索引。 与position_ids相反，此张量不受 padding 的影响。 它用于在正确的位置更新缓存并推断完整的序列长度。
AriaTextModel forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward 传递的配方需要在该函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
AriaTextForCausalLM
用于因果语言建模任务的 Aria 模型。
此类扩展了 LlamaForCausalLM 以合并专家混合 (MoE) 方法，从而实现更高效和可扩展的语言建模。
forward
< source >( input_ids: LongTensor = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Union[typing.List[torch.FloatTensor], transformers.cache_utils.Cache, NoneType] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None cache_position: typing.Optional[torch.LongTensor] = None logits_to_keep: typing.Union[int, torch.Tensor] = 0 **kwargs: typing_extensions.Unpack[transformers.models.aria.modeling_aria.KwargsForCausalLM] ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor，形状为(batch_size, sequence_length)) — 词汇表中输入序列 tokens 的索引。如果提供填充，默认情况下将被忽略。索引可以使用 AutoTokenizer 获得。 请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以了解详细信息。
- attention_mask (
torch.Tensor，形状为(batch_size, sequence_length), 可选) — 用于避免在填充 token 索引上执行注意力的掩码。掩码值在[0, 1]中选择：- 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 表示 head 未被掩盖，
- 0 表示 head 被掩盖。
- position_ids (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 位置嵌入中每个输入序列 tokens 的位置索引。在范围[0, config.n_positions - 1]中选择。 - past_key_values (
Cache或tuple(tuple(torch.FloatTensor)), 可选) — 预先计算的隐藏状态（自注意力模块和交叉注意力模块中的键和值），可用于加速顺序解码。 这通常由模型在先前解码阶段返回的past_key_values组成，当use_cache=True或config.use_cache=True时。允许两种格式：
- Cache 实例，请参阅我们的 kv 缓存指南；
- 长度为
config.n_layers的tuple(tuple(torch.FloatTensor))元组，每个元组具有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的 tensors。 这也称为旧版缓存格式。
模型将输出与作为输入提供的缓存格式相同的格式。 如果未传递
past_key_values，则将返回旧版缓存格式。如果使用
past_key_values，用户可以选择仅输入最后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, 可选) — 是否返回所有注意力层的注意力 tensors。 有关更多详细信息，请参阅返回的 tensors 下的attentions。 - output_hidden_states (
bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回的 tensors 下的hidden_states。 - return_dict (
bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (
torch.LongTensor，形状为(sequence_length), 可选) — 描述输入序列 tokens 在序列中位置的索引。 与position_ids相反，此 tensor 不受填充的影响。 它用于在正确的位置更新缓存，并推断完整的序列长度。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 用于计算掩码语言建模损失的标签。 索引应在[0, ..., config.vocab_size]或 -100 中（请参阅input_ids文档字符串）。 索引设置为-100的 tokens 将被忽略（掩盖），损失仅针对标签在[0, ..., config.vocab_size]中的 tokens 计算。 - logits_to_keep (
int或torch.Tensor, 可选) — 如果是int，则计算最后logits_to_keep个 tokens 的 logits。 如果为0，则计算所有input_ids的 logits（特殊情况）。 仅生成需要最后一个 token logits，并且仅为该 token 计算它们可以节省内存，这对于长序列或大词汇量而言变得非常重要。 如果是torch.Tensor，则必须是与要保留在序列长度维度中的索引相对应的 1D。 当使用 packed tensor 格式（批次和序列长度的单个维度）时，这很有用。
Returns
transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithPast 或一个 torch.FloatTensor 元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，其中包含各种元素，具体取决于配置 (AriaTextConfig) 和输入。
-
loss (
torch.FloatTensor，形状为(1,), 可选, 当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (
torch.FloatTensor，形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模 head 的预测分数（SoftMax 之前每个词汇表 token 的分数）。 -
past_key_values (
tuple(tuple(torch.FloatTensor)), 可选, 当传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的tuple(tuple(torch.FloatTensor))元组，每个元组具有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的 tensors)包含预先计算的隐藏状态（自注意力模块中的键和值），可以用于（请参阅
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)。注意力 softmax 之后的注意力权重，用于计算自注意力 heads 中的加权平均值。
AriaTextForCausalLM forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward 传递的配方需要在该函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> from transformers import AutoTokenizer, AriaTextForCausalLM
>>> model = AriaTextForCausalLM.from_pretrained("meta-aria_text/AriaText-2-7b-hf")
>>> tokenizer = AutoTokenizer.from_pretrained("meta-aria_text/AriaText-2-7b-hf")
>>> prompt = "Hey, are you conscious? Can you talk to me?"
>>> inputs = tokenizer(prompt, return_tensors="pt")
>>> # Generate
>>> generate_ids = model.generate(inputs.input_ids, max_length=30)
>>> tokenizer.batch_decode(generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
"Hey, are you conscious? Can you talk to me?\nI'm not conscious, but I can talk to you."AriaForConditionalGeneration
class transformers.AriaForConditionalGeneration
< source >( config: AriaConfig )
参数
- config (
AriaConfig) — 模型配置类，包含模型的所有参数。 使用配置文件初始化不会加载与模型关联的权重，仅加载配置。 查看 from_pretrained() 方法以加载模型权重。
用于条件生成任务的 Aria 模型。
此模型结合了视觉塔、多模态投影器和语言模型，以执行涉及图像和文本输入的任务。 此模型继承自 PreTrainedModel。 查看超类文档，了解库为所有模型实现的通用方法（例如下载或保存、调整输入嵌入大小、剪枝 head 等）。
此模型也是 PyTorch torch.nn.Module 子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档了解所有与常规用法和行为相关的事项。
forward
< source >( input_ids: LongTensor = None pixel_values: FloatTensor = None pixel_mask: LongTensor = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[typing.List[torch.FloatTensor]] = None inputs_embeds: typing.Optional[torch.FloatTensor] = None labels: typing.Optional[torch.LongTensor] = None use_cache: typing.Optional[bool] = None output_attentions: typing.Optional[bool] = None output_hidden_states: typing.Optional[bool] = None return_dict: typing.Optional[bool] = None logits_to_keep: typing.Union[int, torch.Tensor] = 0 cache_position: typing.Optional[torch.LongTensor] = None **loss_kwargs ) → transformers.models.aria.modeling_aria.AriaCausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor, 可选) — 输入 token IDs。 - pixel_values (
torch.FloatTensor, 可选) — 图像的像素值。 - pixel_mask (
torch.LongTensor, 可选) — 像素值的掩码。 - attention_mask (
torch.Tensor, 可选) — 注意力掩码。 - position_ids (
torch.LongTensor, 可选) — 位置 IDs。 - past_key_values (
List[torch.FloatTensor], 可选) — 用于高效处理的过去键值。 - inputs_embeds (
torch.FloatTensor, 可选) — 输入嵌入。 - labels (
torch.LongTensor, 可选) — 用于计算语言建模损失的标签。 - use_cache (
bool, 可选) — 是否使用模型的缓存机制。 - output_attentions (
bool, 可选) — 是否输出注意力权重。 - output_hidden_states (
bool, 可选) — 是否输出隐藏状态。 - return_dict (
bool, 可选) — 是否返回ModelOutput对象。 - logits_to_keep (
int或torch.Tensor, 可选, 默认为 0) — 如果是int类型，则计算最后logits_to_keep个 token 的 logits，如果为0则计算所有input_ids的 logits。 否则，根据序列长度维度中的 1D 张量进行切片 - cache_position (
torch.LongTensor, 可选) — 缓存位置。 - **loss_kwargs — 用于损失计算的附加关键字参数。
- labels (
torch.LongTensor，形状为(batch_size, sequence_length), 可选) — 用于计算掩码语言建模损失的标签。 索引应在[0, ..., config.vocab_size]或model.image_token_id之间（其中model是您的Idefics3ForConditionalGeneration实例）。 索引设置为model.image_token_id的 token 将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]中的 token 计算。
Returns
transformers.models.aria.modeling_aria.AriaCausalLMOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.models.aria.modeling_aria.AriaCausalLMOutputWithPast 或一个 torch.FloatTensor 元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，包含各种元素，具体取决于配置 (<class 'transformers.models.aria.configuration_aria.AriaConfig'>) 和输入。
-
loss (
torch.FloatTensor，形状为(1,), 可选, 当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (
torch.FloatTensor，形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模 head 的预测分数（SoftMax 之前每个词汇表 token 的分数）。 -
past_key_values (
tuple(tuple(torch.FloatTensor)), 可选, 当传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的tuple(tuple(torch.FloatTensor))元组，每个元组具有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的 tensors)包含预先计算的隐藏状态（自注意力模块中的键和值），可以用于（请参阅
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)。注意力 softmax 之后的注意力权重，用于计算自注意力 heads 中的加权平均值。
-
image_hidden_states (
torch.FloatTensor, 可选) — 一个大小为 (batch_size, num_images, sequence_length, hidden_size)` 的torch.FloatTensor。 由视觉编码器生成并在投影最后一个隐藏状态之后得到的模型的 image_hidden_states。`
The AriaForConditionalGeneration forward 方法，覆盖了 __call__ 特殊方法。
虽然 forward 传递的配方需要在该函数中定义，但之后应该调用 Module 实例而不是此函数，因为前者负责运行预处理和后处理步骤，而后者会静默地忽略它们。
示例
>>> import requests
>>> import torch
>>> from PIL import Image
>>> from io import BytesIO
>>> from transformers import AutoProcessor, AutoModel
>>> from transformers.image_utils import load_image
>>> # Note that passing the image urls (instead of the actual pil images) to the processor is also possible
>>> image1 = load_image("https://cdn.britannica.com/61/93061-050-99147DCE/Statue-of-Liberty-Island-New-York-Bay.jpg")
>>> image2 = load_image("https://cdn.britannica.com/59/94459-050-DBA42467/Skyline-Chicago.jpg")
>>> image3 = load_image("https://cdn.britannica.com/68/170868-050-8DDE8263/Golden-Gate-Bridge-San-Francisco.jpg")
>>> processor = AutoProcessor.from_pretrained("Rhymes-AI/Aria")
>>> model = AutoModel.from_pretrained("Rhymes-AI/Aria", torch_dtype=torch.bfloat16, device_map="auto")
>>> # Create inputs
>>> messages = [
... {
... "role": "user",
... "content": [
... {"type": "image"},
... {"type": "text", "text": "In this image, we can see the city of New York, and more specifically the Statue of Liberty."},
... {"type": "image"},
... {"type": "text", "text": "What can we see in this image?"},
... ]
... },
... {
... "role": "user",
... "content": [
... {"type": "image"},
... {"type": "text", "text": "In which city is that bridge located?"},
... ]
... }
... ]
>>> prompts = [processor.apply_chat_template([message], add_generation_prompt=True) for message in messages]
>>> images = [[image1, image2], [image3]]
>>> inputs = processor(text=prompts, images=images, padding=True, return_tensors="pt").to(model.device)
>>> # Generate
>>> generated_ids = model.generate(**inputs, max_new_tokens=256)
>>> generated_texts = processor.batch_decode(generated_ids, skip_special_tokens=True)
>>> print(generated_texts[0])
Assistant: There are buildings, trees, lights, and water visible in this image.
>>> print(generated_texts[1])
Assistant: The bridge is in San Francisco.