参数

• input_values (torch.FloatTensor，形状为 (batch_size, sequence_length)) — 输入原始语音波形的浮点数值。这些值可以通过将 .flac 或 .wav 音频文件加载到 List[float] 类型的数组或 numpy.ndarray 中获得，例如 通过 soundfile 库 (pip install soundfile)。为了将数组准备成 input_values，应该使用 AutoProcessor 进行填充并转换为 torch.FloatTensor 类型的张量。有关详细信息，请参阅 Wav2Vec2Processor.call()。
• attention_mask (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 用于避免在填充 token 索引上执行卷积和注意力的掩码。掩码值在 [0, 1] 中选择：
  • 1 表示 未被掩盖 的 token，
  • 0 表示 被掩盖 的 token。

  什么是注意力掩码？

  只有当相应的 processor 的 config.return_attention_mask == True 时，才应传递 attention_mask。对于所有 processor 的 config.return_attention_mask == False 的模型，例如 wav2vec2-base，不应 传递 attention_mask，以避免在进行批量推理时性能下降。对于此类模型，input_values 应仅用 0 填充并在不使用 attention_mask 的情况下传递。请注意，这些模型也会根据 input_values 是否填充而产生略有不同的结果。

• output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参阅返回张量下的 attentions。
• output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回张量下的 hidden_states。
• return_dict (bool，可选) — 是否返回 ModelOutput 而不是纯元组。

一个 transformers.modeling_outputs.Wav2Vec2BaseModelOutput 或一个 torch.FloatTensor 元组（如果传递 return_dict=False 或当 config.return_dict=False 时），其中包含各种元素，具体取决于配置 (Wav2Vec2Config) 和输入。

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

• extract_features (torch.FloatTensor，形状为 (batch_size, sequence_length, conv_dim[-1])) — 模型最后一个卷积层的提取特征向量序列。

• 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 之后的注意力权重，用于计算自注意力头中的加权平均值。

参数

• input_values (torch.FloatTensor，形状为 (batch_size, sequence_length)) — 输入原始语音波形的浮点数值。这些值可以通过将 .flac 或 .wav 音频文件加载到 List[float] 类型的数组或 numpy.ndarray 中获得，例如 通过 soundfile 库 (pip install soundfile)。为了将数组准备成 input_values，应该使用 AutoProcessor 进行填充并转换为 torch.FloatTensor 类型的张量。有关详细信息，请参阅 Wav2Vec2Processor.call()。
• attention_mask (torch.LongTensor，形状为 (batch_size, sequence_length)，可选) — 用于避免在填充 token 索引上执行卷积和注意力的掩码。掩码值在 [0, 1] 中选择：
  • 1 表示 未被掩盖 的 token，
  • 0 表示 被掩盖 的 token。

  什么是注意力掩码？

  只有当相应的 processor 的 config.return_attention_mask == True 时，才应传递 attention_mask。对于所有 processor 的 config.return_attention_mask == False 的模型，例如 wav2vec2-base，不应 传递 attention_mask，以避免在进行批量推理时性能下降。对于此类模型，input_values 应仅用 0 填充并在不使用 attention_mask 的情况下传递。请注意，这些模型也会根据 input_values 是否填充而产生略有不同的结果。

• output_attentions (bool，可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参阅返回张量下的 attentions。
• output_hidden_states (bool，可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回张量下的 hidden_states。
• return_dict (bool，可选) — 是否返回 ModelOutput 而不是纯元组。
• labels (torch.LongTensor，形状为 (batch_size, target_length)，可选) — 用于连接时序分类的标签。 请注意，target_length 必须小于或等于输出 logits 的序列长度。 索引在 [-100, 0, ..., config.vocab_size - 1] 中选择。 所有设置为 -100 的标签都将被忽略（掩盖），损失仅针对 [0, ..., config.vocab_size - 1] 中的标签计算。

一个 transformers.modeling_outputs.CausalLMOutput 或一个 torch.FloatTensor 元组（如果传递 return_dict=False 或当 config.return_dict=False 时），其中包含各种元素，具体取决于配置 (Wav2Vec2Config) 和输入。

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

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

• 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 之后的注意力权重，用于计算自注意力头中的加权平均值。

参数

• target_lang (str) — 必须是现有适配器权重的语言 ID。适配器权重以 adapter.<lang>.safetensors 或 adapter.<lang>.bin 格式存储。
• force_load (bool，默认为 True) — 即使 target_lang 与 self.target_lang 匹配，是否仍应加载权重。
• cache_dir (Union[str, os.PathLike], 可选) — 用于指定一个目录的路径，如果不想使用标准缓存，下载的预训练模型配置应缓存到该目录中。
• force_download (bool, 可选, 默认为 False) — 是否强制重新下载模型权重和配置文件，覆盖缓存版本（如果存在）。 resume_download — 已弃用并忽略。现在所有下载在可能的情况下都默认恢复。将在 Transformers v5 版本中移除。
• proxies (Dict[str, str], 可选) — 一个字典，用于按协议或端点指定要使用的代理服务器，例如： {'http': 'foo.bar:3128', 'http://hostname': 'foo.bar:4012'}。代理服务器用于每个请求。
• local_files_only(bool, 可选, 默认为 False) — 是否仅查看本地文件（即，不尝试下载模型）。
• token (str 或 bool, 可选) — 用作远程文件 HTTP Bearer 授权的令牌。如果为 True，或未指定，将使用运行 huggingface-cli login 时生成的令牌（存储在 ~/.huggingface 中）。
• revision (str, 可选, 默认为 "main") — 要使用的特定模型版本。它可以是分支名称、标签名称或提交 ID，因为我们使用基于 git 的系统在 huggingface.co 上存储模型和其他工件，因此 revision 可以是 git 允许的任何标识符。

  要测试您在 Hub 上创建的拉取请求，您可以传递 `revision=“refs/pr/“。

• mirror (str, 可选) — 镜像源，用于加速在中国的下载。如果您来自中国并且遇到可访问性问题，您可以设置此选项来解决它。请注意，我们不保证及时性或安全性。有关更多信息，请参阅镜像站点。

参数

• input_values (torch.FloatTensor，形状为 (batch_size, sequence_length)) — 原始语音波形的浮点值。值可以通过将 .flac 或 .wav 音频文件加载到 List[float] 类型的数组或 numpy.ndarray 中获得，例如 通过 soundfile 库 (pip install soundfile)。为了将数组准备为 input_values，应该使用 AutoProcessor 进行填充并转换为 torch.FloatTensor 类型的张量。有关详细信息，请参阅 Wav2Vec2Processor.call()。
• attention_mask (torch.LongTensor，形状为 (batch_size, sequence_length), 可选) — 用于避免在 padding 标记索引上执行卷积和注意力的掩码。掩码值在 [0, 1] 中选择：
  • 1 表示 未被掩盖 的标记，
  • 0 表示 被掩盖 的标记。

  什么是注意力掩码？

  只有当相应的 processor 具有 config.return_attention_mask == True 时，才应传递 attention_mask。对于所有 processor 具有 config.return_attention_mask == False 的模型，例如 wav2vec2-base，不应 传递 attention_mask 以避免在执行批量推理时性能下降。对于此类模型，input_values 应简单地用 0 填充并在没有 attention_mask 的情况下传递。请注意，这些模型也会产生略微不同的结果，具体取决于 input_values 是否被填充。

• output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
• output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的 hidden_states。
• return_dict (bool, 可选) — 是否返回 ModelOutput 而不是纯元组。
• labels (torch.LongTensor，形状为 (batch_size,), 可选) — 用于计算序列分类/回归损失的标签。索引应在 [0, ..., config.num_labels - 1] 中。如果 config.num_labels == 1，则计算回归损失（均方误差损失），如果 config.num_labels > 1，则计算分类损失（交叉熵损失）。

一个 transformers.modeling_outputs.SequenceClassifierOutput 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含各种元素，具体取决于配置 (Wav2Vec2Config) 和输入。

• loss (torch.FloatTensor，形状为 (1,), 可选, 当提供 labels 时返回) — 分类（或回归，如果 config.num_labels==1）损失。

• logits (torch.FloatTensor，形状为 (batch_size, config.num_labels)) — 分类（或回归，如果 config.num_labels==1）得分（在 SoftMax 之前）。

• 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 之后的注意力权重，用于计算自注意力头中的加权平均值。

参数

• input_values (torch.FloatTensor，形状为 (batch_size, sequence_length)) — 原始语音波形的浮点值。值可以通过将 .flac 或 .wav 音频文件加载到 List[float] 类型的数组或 numpy.ndarray 中获得，例如 通过 soundfile 库 (pip install soundfile)。为了将数组准备为 input_values，应该使用 AutoProcessor 进行填充并转换为 torch.FloatTensor 类型的张量。有关详细信息，请参阅 Wav2Vec2Processor.call()。
• attention_mask (torch.LongTensor，形状为 (batch_size, sequence_length), 可选) — 用于避免在 padding 标记索引上执行卷积和注意力的掩码。掩码值在 [0, 1] 中选择：
  • 1 表示 未被掩盖 的标记，
  • 0 表示 被掩盖 的标记。

  什么是注意力掩码？

  只有当相应的 processor 具有 config.return_attention_mask == True 时，才应传递 attention_mask。对于所有 processor 具有 config.return_attention_mask == False 的模型，例如 wav2vec2-base，不应 传递 attention_mask 以避免在执行批量推理时性能下降。对于此类模型，input_values 应简单地用 0 填充并在没有 attention_mask 的情况下传递。请注意，这些模型也会产生略微不同的结果，具体取决于 input_values 是否被填充。

• output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的 attentions。
• output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。 详见返回张量下的 hidden_states。
• return_dict (bool, optional) — 是否返回 ModelOutput 对象而不是普通元组。
• labels (torch.LongTensor，形状为 (batch_size,)，optional) — 用于计算序列分类/回归损失的标签。 索引应在 [0, ..., config.num_labels - 1] 中。 如果 config.num_labels == 1，则计算回归损失（均方误差损失）；如果 config.num_labels > 1，则计算分类损失（交叉熵损失）。

一个 transformers.modeling_outputs.TokenClassifierOutput 对象或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包含各种元素，具体取决于配置 (Wav2Vec2Config) 和输入。

• loss (torch.FloatTensor，形状为 (1,)，optional，当提供 labels 时返回) — 分类损失。

• logits (torch.FloatTensor，形状为 (batch_size, sequence_length, config.num_labels)) — 分类得分（SoftMax 之前）。

• 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 之后的注意力权重，用于计算自注意力头中的加权平均值。

参数

• input_values (torch.FloatTensor，形状为 (batch_size, sequence_length)) — 输入原始语音波形的浮点数值。 值可以通过将 .flac 或 .wav 音频文件加载到 List[float] 类型的数组或 numpy.ndarray 数组中获得，例如 通过 soundfile 库 (pip install soundfile)。 要将数组准备为 input_values，应使用 AutoProcessor 进行填充并转换为 torch.FloatTensor 类型的张量。 有关详细信息，请参阅 Wav2Vec2Processor.call()。
• attention_mask (torch.LongTensor，形状为 (batch_size, sequence_length)，optional) — 用于避免在填充 token 索引上执行卷积和注意力的掩码。 在 [0, 1] 中选择掩码值：
  • 1 表示 未被掩码 的 token，
  • 0 表示 被掩码 的 token。

  什么是注意力掩码？

  只有当对应的 processor 具有 config.return_attention_mask == True 时，才应传递 attention_mask。 对于所有 processor 具有 config.return_attention_mask == False 的模型，例如 wav2vec2-base，不应 传递 attention_mask，以避免在进行批量推理时性能下降。 对于此类模型，input_values 应仅使用 0 填充，并在不使用 attention_mask 的情况下传递。 请注意，这些模型也会根据 input_values 是否填充而产生略有不同的结果。

• output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。 详见返回张量下的 attentions。
• output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。 详见返回张量下的 hidden_states。
• return_dict (bool, optional) — 是否返回 ModelOutput 对象而不是普通元组。
• labels (torch.LongTensor，形状为 (batch_size,)，optional) — 用于计算序列分类/回归损失的标签。 索引应在 [0, ..., config.num_labels - 1] 中。 如果 config.num_labels == 1，则计算回归损失（均方误差损失）；如果 config.num_labels > 1，则计算分类损失（交叉熵损失）。

一个 transformers.modeling_outputs.XVectorOutput 对象或一个 torch.FloatTensor 元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），其中包含各种元素，具体取决于配置 (Wav2Vec2Config) 和输入。

• loss (torch.FloatTensor，形状为 (1,)，optional，当提供 labels 时返回) — 分类损失。

• logits (torch.FloatTensor，形状为 (batch_size, config.xvector_output_dim)) — AMSoftmax 之前的分类隐藏状态。

• embeddings (torch.FloatTensor，形状为 (batch_size, config.xvector_output_dim)) — 用于基于向量相似度检索的语句嵌入。

• 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 之后的注意力权重，用于计算自注意力头中的加权平均值。

参数

• input_values (torch.FloatTensor，形状为 (batch_size, sequence_length)) — 输入原始语音波形的浮点数值。 值可以通过将 .flac 或 .wav 音频文件加载到 List[float] 类型的数组或 numpy.ndarray 数组中获得，例如 通过 soundfile 库 (pip install soundfile)。 要将数组准备为 input_values，应使用 AutoProcessor 进行填充并转换为 torch.FloatTensor 类型的张量。 有关详细信息，请参阅 Wav2Vec2Processor.call()。
• attention_mask (torch.LongTensor，形状为 (batch_size, sequence_length)，optional) — 用于避免在填充 token 索引上执行卷积和注意力的掩码。 在 [0, 1] 中选择掩码值：
  • 1 表示 未被掩码 的 token，
  • 0 表示 被掩码 的 token。

  什么是注意力掩码？

  只有当对应的 processor 具有 config.return_attention_mask == True 时，才应传递 attention_mask。 对于所有 processor 具有 config.return_attention_mask == False 的模型，例如 wav2vec2-base，不应 传递 attention_mask，以避免在进行批量推理时性能下降。 对于此类模型，input_values 应仅使用 0 填充，并在不使用 attention_mask 的情况下传递。 请注意，这些模型也会根据 input_values 是否填充而产生略有不同的结果。

• output_attentions (bool, optional) — 是否返回所有注意力层的注意力张量。 详见返回张量下的 attentions。
• output_hidden_states (bool, optional) — 是否返回所有层的隐藏状态。 详见返回张量下的 hidden_states。
• return_dict (bool, optional) — 是否返回 ModelOutput 对象而不是普通元组。
• mask_time_indices (torch.BoolTensor, 形状为 (batch_size, sequence_length), 可选) — 用于对比损失的掩码提取特征的索引。当处于训练模式时，模型学习预测 config.proj_codevector_dim 空间中被掩码的提取特征。
• sampled_negative_indices (torch.BoolTensor, 形状为 (batch_size, sequence_length, num_negatives), 可选) — 指示哪些量化目标向量用作对比损失中的负采样的向量的索引。预训练的必需输入。

一个 transformers.models.wav2vec2.modeling_wav2vec2.Wav2Vec2ForPreTrainingOutput 或一个 torch.FloatTensor 的元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，包含取决于配置 (Wav2Vec2Config) 和输入的各种元素。

• loss (可选, 当传递 sample_negative_indices 时返回, torch.FloatTensor, 形状为 (1,)) — 总损失，为对比损失 (L_m) 和多样性损失 (L_d) 的总和，如 官方论文 中所述。(分类) 损失。

• projected_states (torch.FloatTensor, 形状为 (batch_size, sequence_length, config.proj_codevector_dim)) — 模型投影到 config.proj_codevector_dim 的隐藏状态，可用于预测被掩码的投影量化状态。

• projected_quantized_states (torch.FloatTensor, 形状为 (batch_size, sequence_length, config.proj_codevector_dim)) — 量化的提取特征向量投影到 config.proj_codevector_dim，表示对比损失的正目标向量。

• 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 之后的注意力权重，用于计算自注意力头中的加权平均值。

• contrastive_loss (可选, 当传递 sample_negative_indices 时返回, torch.FloatTensor, 形状为 (1,)) — 对比损失 (L_m)，如 官方论文 中所述。

• diversity_loss (可选, 当传递 sample_negative_indices 时返回, torch.FloatTensor, 形状为 (1,)) — 多样性损失 (L_d)，如 官方论文 中所述。

参数

• input_values (np.ndarray, tf.Tensor, List[tf.Tensor] Dict[str, tf.Tensor] 或 Dict[str, np.ndarray]，并且每个示例都必须具有形状 ({0})) — 词汇表中输入序列标记的索引。

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

  什么是输入 ID？

• attention_mask (np.ndarray 或 tf.Tensor，形状为 ({0}), 可选) — 掩码，以避免对填充标记索引执行注意力机制。掩码值在 [0, 1] 中选择：
  • 1 表示标记未被掩码，
  • 0 表示标记已被掩码。

  什么是注意力掩码？

• token_type_ids (np.ndarray 或 tf.Tensor，形状为 ({0}), 可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引在 [0, 1] 中选择：
  • 0 对应于句子 A 标记，
  • 1 对应于句子 B 标记。

  什么是标记类型 ID？

• position_ids (np.ndarray 或 tf.Tensor，形状为 ({0}), 可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。

  什么是位置 ID？

• head_mask (np.ndarray 或 tf.Tensor，形状为 (num_heads,) 或 (num_layers, num_heads), 可选) — 用于使自注意力模块的选定头部无效的掩码。掩码值在 [0, 1] 中选择：
  • 1 表示头部未被掩码，
  • 0 表示头部已被掩码。
• inputs_embeds (np.ndarray 或 tf.Tensor，形状为 ({0}, hidden_size), 可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_values。如果您希望比模型的内部嵌入查找矩阵更精确地控制如何将 input_values 索引转换为关联的向量，这将非常有用。
• output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参见返回的张量下的 attentions。 此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。
• output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参见返回的张量下的 hidden_states。 此参数只能在 eager 模式下使用，在 graph 模式下将使用配置中的值。
• return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通元组。 此参数可以在 eager 模式下使用，在 graph 模式下，该值将始终设置为 True。
• training (bool, 可选, 默认为 “False”) — 是否在训练模式下使用模型（某些模块（如 dropout 模块）在训练和评估之间具有不同的行为）。

一个 transformers.modeling_tf_outputs.TFBaseModelOutput 或一个 tf.Tensor 的元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，包含取决于配置 (Wav2Vec2Config) 和输入的各种元素。

• last_hidden_state (tf.Tensor，形状为 (batch_size, sequence_length, hidden_size)) — 模型最后一层输出处的隐藏状态序列。

• hidden_states (tuple(tf.FloatTensor), 可选, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — tf.Tensor 的元组（每个嵌入输出 + 每层输出一个），形状为 (batch_size, sequence_length, hidden_size)。

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

• attentions (tuple(tf.Tensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — tf.Tensor 的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

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

参数

• input_values (np.ndarray, tf.Tensor, List[tf.Tensor] Dict[str, tf.Tensor] 或 Dict[str, np.ndarray] 并且每个示例必须具有形状 ({0})) — 词汇表中输入序列 tokens 的索引。

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

  什么是输入 IDs? (What are input IDs?)

• attention_mask (np.ndarray 或 tf.Tensor，形状为 ({0})，可选) — 用于避免对 padding token 索引执行 attention 的掩码。 掩码值在 [0, 1] 中选择：
  • 1 表示 tokens 未被掩盖 (not masked)，
  • 0 表示 tokens 被掩盖 (masked)。

  什么是 attention 掩码? (What are attention masks?)

• token_type_ids (np.ndarray 或 tf.Tensor，形状为 ({0})，可选) — 用于指示输入的第一部分和第二部分的片段 token 索引。索引在 [0, 1] 中选择：
  • 0 对应于 句子 A token，
  • 1 对应于 句子 B token。

  什么是 token 类型 IDs? (What are token type IDs?)

• position_ids (np.ndarray 或 tf.Tensor，形状为 ({0})，可选) — 位置嵌入中每个输入序列 token 的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。

  什么是位置 IDs? (What are position IDs?)

• head_mask (np.ndarray 或 tf.Tensor，形状为 (num_heads,) 或 (num_layers, num_heads)，可选) — 用于使自注意力模块的选定 head 无效的掩码。 掩码值在 [0, 1] 中选择：
  • 1 表示 head 未被掩盖 (not masked)，
  • 0 表示 head 被掩盖 (masked)。
• inputs_embeds (np.ndarray 或 tf.Tensor，形状为 ({0}, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递 input_values。 如果您想要比模型的内部嵌入查找矩阵更好地控制如何将 input_values 索引转换为关联的向量，这将非常有用。
• output_attentions (bool, 可选) — 是否返回所有 attention 层的 attentions tensors。 有关更多详细信息，请参阅返回的 tensors 下的 attentions。 此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。
• output_hidden_states (bool, 可选) — 是否返回所有层的 hidden states。 有关更多详细信息，请参阅返回的 tensors 下的 hidden_states。 此参数只能在 eager 模式下使用，在 graph 模式下将使用 config 中的值。
• return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通的 tuple。 此参数可以在 eager 模式下使用，在 graph 模式下该值将始终设置为 True。
• training (bool, 可选, 默认为 `False“) — 是否在训练模式下使用模型（dropout 模块等某些模块在训练和评估之间具有不同的行为）。
• labels (tf.Tensor 或 np.ndarray，形状为 (batch_size, sequence_length)，可选) — 用于计算掩码语言建模损失的标签。 索引应在 [-100, 0, ..., config.vocab_size] 中（参见 input_values 文档字符串）。索引设置为 -100 的 tokens 将被忽略（掩盖），损失仅针对标签在 [0, ..., config.vocab_size] 中的 tokens 计算。

一个 transformers.modeling_tf_outputs.TFCausalLMOutput 或 tf.Tensor 的 tuple（如果传递 return_dict=False 或当 config.return_dict=False 时），包含取决于配置 (Wav2Vec2Config) 和输入的各种元素。

• loss (tf.Tensor，形状为 (n,)，可选，当提供 labels 时返回，其中 n 是未被掩盖标签的数量) — 语言建模损失（用于下一个 token 预测）。

• logits (tf.Tensor，形状为 (batch_size, sequence_length, config.vocab_size)) — 语言建模 head 的预测分数（SoftMax 之前每个词汇表 token 的分数）。

• hidden_states (tuple(tf.Tensor), 可选，当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — tf.Tensor 的 tuple（embeddings 的输出一个，每层的输出一个），形状为 (batch_size, sequence_length, hidden_size)。

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

• attentions (tuple(tf.Tensor), 可选, 当传递 output_attentions=True 或当 config.output_attentions=True 时返回) — tf.Tensor 的元组（每层一个），形状为 (batch_size, num_heads, sequence_length, sequence_length)。

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

参数

• input_values (形状为 (batch_size, sequence_length) 的 jnp.ndarray) — 输入原始语音波形的浮点数值。这些值可以通过将 .flac 或 .wav 音频文件加载到 List[float] 类型的数组或 numpy.ndarray 中获得，例如 通过 soundfile 库 (pip install soundfile)。 为了将数组准备成 input_values，应该使用 AutoProcessor 进行填充和转换为 jnp.ndarray 类型的张量。 有关详细信息，请参阅 Wav2Vec2Processor.call()。
• attention_mask (形状为 (batch_size, sequence_length) 的 jnp.ndarray, 可选) — 用于避免在 padding 标记索引上执行卷积和注意力的掩码。 掩码值在 [0, 1] 中选择：
  • 1 表示 未被掩盖 的标记，
  • 0 表示 被掩盖 的标记。

  什么是注意力掩码？ .. warning:: 仅当对应的 processor 具有 config.return_attention_mask == True 时，才应传递 attention_mask。 对于所有 processor 具有 config.return_attention_mask == False 的模型，例如 wav2vec2-base，不应 传递 attention_mask，以避免在进行批量推理时性能下降。 对于此类模型，input_values 应该简单地用 0 填充，并在不使用 attention_mask 的情况下传递。 请注意，这些模型也会根据 input_values 是否填充而产生略有不同的结果。

• mask_time_indices (形状为 (batch_size, sequence_length) 的 jnp.ndarray, 可选) — 用于掩盖提取特征以进行对比损失的索引。 当处于训练模式时，模型学习在 config.proj_codevector_dim 空间中预测被掩盖的提取特征。
• output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参阅返回张量下的 attentions。
• output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回张量下的 hidden_states。
• return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。

一个 transformers.models.wav2vec2.modeling_flax_wav2vec2.FlaxWav2Vec2BaseModelOutput 或一个 torch.FloatTensor 元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，其中包含各种元素，具体取决于配置 (<class 'transformers.models.wav2vec2.configuration_wav2vec2.Wav2Vec2Config'>) 和输入。

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

• extract_features (形状为 (batch_size, sequence_length, last_conv_dim) 的 jnp.ndarray) — 模型最后一个卷积层的提取特征向量序列，其中 last_conv_dim 是最后一个卷积层的维度。

• hidden_states (tuple(jnp.ndarray), 可选, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 形状为 (batch_size, sequence_length, hidden_size) 的 jnp.ndarray 元组（embeddings 的输出一个，加上每层的输出一个）。

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

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

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

参数

• input_values (形状为 (batch_size, sequence_length) 的 jnp.ndarray) — 输入原始语音波形的浮点数值。这些值可以通过将 .flac 或 .wav 音频文件加载到 List[float] 类型的数组或 numpy.ndarray 中获得，例如 通过 soundfile 库 (pip install soundfile)。 为了将数组准备成 input_values，应该使用 AutoProcessor 进行填充和转换为 jnp.ndarray 类型的张量。 有关详细信息，请参阅 Wav2Vec2Processor.call()。
• attention_mask (形状为 (batch_size, sequence_length) 的 jnp.ndarray, 可选) — 用于避免在 padding 标记索引上执行卷积和注意力的掩码。 掩码值在 [0, 1] 中选择：
  • 1 表示 未被掩盖 的标记，
  • 0 表示 被掩盖 的标记。

  什么是注意力掩码？ .. warning:: 仅当对应的 processor 具有 config.return_attention_mask == True 时，才应传递 attention_mask。 对于所有 processor 具有 config.return_attention_mask == False 的模型，例如 wav2vec2-base，不应 传递 attention_mask，以避免在进行批量推理时性能下降。 对于此类模型，input_values 应该简单地用 0 填充，并在不使用 attention_mask 的情况下传递。 请注意，这些模型也会根据 input_values 是否填充而产生略有不同的结果。

• mask_time_indices (形状为 (batch_size, sequence_length) 的 jnp.ndarray, 可选) — 用于掩盖提取特征以进行对比损失的索引。 当处于训练模式时，模型学习在 config.proj_codevector_dim 空间中预测被掩盖的提取特征。
• output_attentions (bool, 可选) — 是否返回所有注意力层的注意力张量。 有关更多详细信息，请参阅返回张量下的 attentions。
• output_hidden_states (bool, 可选) — 是否返回所有层的隐藏状态。 有关更多详细信息，请参阅返回张量下的 hidden_states。
• return_dict (bool, 可选) — 是否返回 ModelOutput 而不是普通的元组。

一个 transformers.modeling_flax_outputs.FlaxMaskedLMOutput 或一个 torch.FloatTensor 元组 (如果传递了 return_dict=False 或当 config.return_dict=False 时)，其中包含各种元素，具体取决于配置 (<class 'transformers.models.wav2vec2.configuration_wav2vec2.Wav2Vec2Config'>) 和输入。

• logits (形状为 (batch_size, sequence_length, config.vocab_size) 的 jnp.ndarray) — 语言建模头的预测分数（SoftMax 之前每个词汇表标记的分数）。

• hidden_states (tuple(jnp.ndarray), 可选, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — 形状为 (batch_size, sequence_length, hidden_size) 的 jnp.ndarray 元组（embeddings 的输出一个，加上每层的输出一个）。

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

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

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