Transformers 文档
Granite 语音模型
并获得增强的文档体验
开始使用
Granite 语音模型
概述
Granite 语音模型是一个多模态语言模型，由语音编码器、语音投影器、大型语言模型和 LoRA 适配器组成。关于当前（Granite 3.2 Speech）模型架构中每个组件的更多细节，请参见下文。
语音编码器：一个 Conformer 编码器，使用连接主义时间分类 (CTC) 在 ASR 语料库上对字符级目标进行训练。编码器使用块注意力（block-attention）和中间层的自条件 CTC。
语音投影器：一个对最后一个编码器块的输出进行操作的查询转换器（q-former）。编码器和投影器对音频特征进行时间下采样，以便合并到由 llm 处理的多模态嵌入中。
大型语言模型：Granite 语音模型利用 Granite LLM，该模型最初在 这篇论文 中提出。
LoRA 适配器：Granite 语音模型包含一个特定于模态的 LoRA，当提供音频特征时将启用，否则禁用。
请注意，上述大多数组件都是通用实现的，以实现与 transformers 中其他模型架构的兼容性和潜在集成。
此模型由 Alexander Brooks、Avihu Dekel 和 George Saon 贡献。
使用提示
- 此模型捆绑了自己的 LoRA 适配器，将在推理调用期间根据需要自动加载和启用/禁用。请务必安装 PEFT 以确保 LoRA 正确应用！
GraniteSpeechConfig
class transformers.GraniteSpeechConfig
< 源文件 >( text_config = None encoder_config = None projector_config = None audio_token_index = 49155 initializer_range = 0.02 has_lora_adapter = True downsample_rate = 5 window_size = 15 **kwargs )
参数
- text_config (
Union[AutoConfig, dict], 可选, 默认为GraniteConfig) — 文本骨干的配置对象或字典。 - encoder_config (
GraniteSpeechEncoderConfig, 可选) — Granite Speech CTC 编码器的配置对象或字典。 - projector_config (
Union[AutoConfig, dict], 可选, 默认为Blip2QFormerConfig) — 音频投影器的配置对象或字典。 - audio_token_index (
int, 可选, 默认为 49155) — 用于编码音频提示的音频标记索引。 - initializer_range (
float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的 truncated_normal_initializer 的标准差。 - has_lora_adapter (
bool, 可选, 默认为True) — 指示模型是否具有 LoRA 适配器，该适配器应仅在处理音频输入时激活，否则禁用。 - downsample_rate (
int, 可选, 默认为 5) — 音频特征提取器的下采样率。 - window_size (
int, 可选, 默认为 15) — 音频特征投影器的窗口大小。
这是用于存储 GraniteSpeechForConditionalGeneration 配置的配置类。它用于根据指定参数实例化 Granite 语音模型，定义模型架构。
配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请参阅 PretrainedConfig 的文档。
示例
>>> from transformers import GraniteSpeechConfig, GraniteSpeechForConditionalGeneration
>>> # Initializing a GraniteSpeechConfig
>>> configuration = GraniteSpeechConfig()
>>> # Initializing a GraniteSpeechForConditionalGeneration (with random weights)
>>> model = GraniteSpeechForConditionalGeneration(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configGraniteSpeechEncoderConfig
class transformers.GraniteSpeechEncoderConfig
< 源文件 >( input_dim = 160 num_layers = 10 hidden_dim = 1024 feedforward_mult = 4 num_heads = 8 dim_head = 128 output_dim = 42 context_size = 200 max_pos_emb = 512 dropout = 0.1 conv_kernel_size = 15 conv_expansion_factor = 2 **kwargs )
参数
- input_dim (
int, 可选, 默认为 160) — 编码器第一个隐藏层的维度。 - num_layers (
int, 可选, 默认为 10) — 编码器块的数量。 - hidden_dim (
int, 可选, 默认为 1024) — Conformer 编码器中间层的大小。 - feedforward_mult (
int, 可选, 默认为 4) — 编码器前馈层中上/下投影的乘数；投影的中间维度大小为hidden_dim * feedforward_mult。 - num_heads (
int, 可选, 默认为 8) — Transformer 编码器中每个注意力层的注意力头数量。 - dim_head (
int, 可选, 默认为 128) — Transformer 编码器中每个注意力层的注意力头维度。 - output_dim (
int, 可选, 默认为 42) — Conformer 中间层的输出维度，将被添加到每个其他编码器块的输出中。 - context_size (
int, 可选, 默认为 200) — Conformer 注意力中使用的上下文大小。 - max_pos_emb (
int, 可选, 默认为 512) — 注意力中使用的最大位置嵌入（Shaw 的相对位置编码）。 - dropout (
float, 可选, 默认为 0.1) — 编码器中全连接层的 dropout 概率。 - conv_kernel_size (
int, 可选, 默认为 15) — 每个 Conformer 块中用于 1D 卷积的核大小。 - conv_expansion_factor (
int, 可选, 默认为 2) — Conformer 卷积中使用的中间维度。
这是用于存储 GraniteSpeechCTCEncoder 配置的配置类。它用于根据指定参数实例化 Granite 语音音频编码器，定义模型架构。使用默认值实例化配置将生成与 Granite 语音架构音频编码器类似的配置。
配置对象继承自 PretrainedConfig，可用于控制模型输出。有关更多信息，请参阅 PretrainedConfig 的文档。
示例
>>> from transformers import GraniteSpeechEncoderConfig, GraniteSpeechCTCEncoder
>>> # Initializing a GraniteSpeechEncoderConfig
>>> configuration = GraniteSpeechEncoderConfig()
>>> # Initializing a GraniteSpeechCTCEncoder (with random weights)
>>> model = GraniteSpeechCTCEncoder(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configGraniteSpeechProcessor
class transformers.GraniteSpeechProcessor
< 源文件 >( audio_processor tokenizer audio_token = '<|audio|>' chat_template = None )
GraniteSpeechFeatureExtractor
class transformers.GraniteSpeechFeatureExtractor
< 源文件 >( sampling_rate: int = 16000 n_fft: int = 512 win_length: int = 400 hop_length: int = 160 n_mels: int = 80 projector_window_size: int = 15 projector_downsample_rate: int = 5 **kwargs )
GraniteSpeechForConditionalGeneration
class transformers.GraniteSpeechForConditionalGeneration
< 源文件 >( config: GraniteSpeechConfig )
参数
- config (GraniteSpeechConfig) — 包含模型所有参数的模型配置类。用配置文件初始化并不会加载与模型相关的权重，只加载配置。请查阅 from_pretrained() 方法来加载模型权重。
Granite 语音模型，由音频编码器、投影器和语言模型组成。
此模型继承自 PreTrainedModel。请查阅超类文档，了解库为所有模型实现的通用方法（如下载或保存、调整输入嵌入大小、修剪头部等）。
此模型也是 PyTorch torch.nn.Module 子类。将其作为常规 PyTorch 模块使用，并参阅 PyTorch 文档以了解所有与一般用法和行为相关的事项。
forward
< 源文件 >( input_ids: LongTensor = None input_features: FloatTensor = None input_features_mask: typing.Optional[torch.Tensor] = None attention_mask: typing.Optional[torch.Tensor] = None position_ids: typing.Optional[torch.LongTensor] = None past_key_values: typing.Optional[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 cache_position: typing.Optional[torch.LongTensor] = None logits_to_keep: typing.Union[int, torch.Tensor] = 0 **lm_kwargs ) → transformers.models.granite_speech.modeling_granite_speech.GraniteSpeechCausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。默认情况下会忽略填充。可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call()。
- input_features (
torch.FloatTensor形状为(batch_size, audio seq len, mel feat dim)) -- 对应输入音频的张量。可以使用 [AutoFeatureExtractor](/docs/transformers/v4.53.3/en/model_doc/auto#transformers.AutoFeatureExtractor) 获取输入特征。有关详细信息，请参阅GraniteSpeechFeatureExtractor.call()`。GraniteSpeechProcessor 使用 GraniteSpeechFeatureExtractor 进行音频处理。 - input_features_mask (
torch.Tensor, 可选) — 在分散到语言嵌入之前应用于音频特征的掩码。 - attention_mask (
torch.Tensor形状为(batch_size, sequence_length), 可选) — 避免对填充标记索引执行注意力操作的掩码。掩码值选择在[0, 1]之间：- 1 表示**未被遮蔽**的标记，
- 0 表示**被遮蔽**的标记。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length), 可选) — 每个输入序列标记在位置嵌入中的位置索引。选择范围为[0, config.n_positions - 1]。 - past_key_values (
list[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)，而不是所有input_ids形状为(batch_size, sequence_length)。 - inputs_embeds (
torch.FloatTensor，形状为(batch_size, sequence_length, hidden_size)，可选) — 可选参数，可以直接传入嵌入表示而不是input_ids。如果你想对如何将input_ids索引转换为相关向量拥有比模型内部嵌入查找矩阵更强的控制，这会很有用。 - labels (
torch.LongTensor，形状为(batch_size, sequence_length)，可选) — 用于计算掩码语言建模损失的标签。索引应在[0, ..., config.vocab_size]范围内或为 -100（参阅input_ids文档字符串）。索引设置为-100的标记将被忽略（掩码），损失仅针对标签在[0, ..., config.vocab_size]范围内的标记计算。 - 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不同，此张量不受填充影响。它用于在正确位置更新缓存并推断完整的序列长度。 - logits_to_keep (
Union[int, torch.Tensor]，默认为0) — 如果是int，则计算最后logits_to_keep个标记的 logits。如果是0，则计算所有input_ids的 logits（特殊情况）。生成时只需要最后一个标记的 logits，只计算该标记的 logits 可以节省内存，这对于长序列或大词汇量来说非常重要。如果是torch.Tensor，则必须是与序列长度维度中要保留的索引对应的 1D 张量。这在使用打包张量格式（批次和序列长度的单维度）时很有用。
返回
transformers.models.granite_speech.modeling_granite_speech.GraniteSpeechCausalLMOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.models.granite_speech.modeling_granite_speech.GraniteSpeechCausalLMOutputWithPast 对象或一个 torch.FloatTensor 元组（如果传入 return_dict=False 或当 config.return_dict=False 时），其中包含根据配置 (GraniteSpeechConfig) 和输入的不同元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，当提供labels时返回) — 语言建模损失（用于下一个 token 预测）。 -
logits (形状为
(batch_size, sequence_length, config.vocab_size)的torch.FloatTensor) — 语言建模头部的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
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)的张量。包含预计算的隐藏状态（自注意力块中的键和值），可用于（参见
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 后的注意力权重，用于计算自注意力头中的加权平均值。
GraniteSpeechForConditionalGeneration 的 forward 方法，覆盖了 __call__ 特殊方法。
虽然前向传播的实现需要在该函数内部定义，但之后应该调用 Module 实例而不是直接调用此函数，因为前者会处理预处理和后处理步骤，而后者会默默忽略它们。
示例
>>> from transformers import AutoProcessor, GraniteSpeechForConditionalGeneration
>>> from datasets import load_dataset
>>> import torch
>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation")
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate
>>> processor = AutoProcessor.from_pretrained("None")
>>> model = GraniteSpeechForConditionalGeneration.from_pretrained("None")
>>> # audio file is decoded on the fly
>>> inputs = processor(dataset[0]["audio"]["array"], sampling_rate=sampling_rate, return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_ids = torch.argmax(logits, dim=-1)
>>> # transcribe speech
>>> transcription = processor.batch_decode(predicted_ids)
>>> transcription[0]
...
>>> inputs["labels"] = processor(text=dataset[0]["text"], return_tensors="pt").input_ids
>>> # compute loss
>>> loss = model(**inputs).loss
>>> round(loss.item(), 2)
...