Transformers 文档

SeedOss

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

该模型于 2025 年 8 月 22 日贡献给 Hugging Face Transformers。

SDPA Tensor parallelism

SeedOss

SeedOss 是字节跳动 Seed 推出的 36B 参数稠密语言模型,具有原生 512K 上下文长度。它具备灵活的思考预算控制能力,以及强大的推理和智能体(Agent)能力,在 12T token 上完成训练。

以下示例演示了如何使用 PipelineAutoModelForCausalLM 类生成文本。

流水线
AutoModelForCausalLM
from transformers import pipeline


pipe = pipeline(
    task="text-generation",
    model="ByteDance-Seed/Seed-OSS-36B-Base",
)
pipe("The most important factor in language model training is")

SeedOssConfig

class transformers.SeedOssConfig

< >

( transformers_version: str | None = None architectures: list[str] | None = None output_hidden_states: bool | None = False return_dict: bool | None = True dtype: typing.Union[str, ForwardRef('torch.dtype'), NoneType] = None chunk_size_feed_forward: int = 0 is_encoder_decoder: bool = False id2label: dict[int, str] | dict[str, str] | None = None label2id: dict[str, int] | dict[str, str] | None = None problem_type: typing.Optional[typing.Literal['regression', 'single_label_classification', 'multi_label_classification']] = None vocab_size: int = 155136 hidden_size: int = 4096 intermediate_size: int = 27648 num_hidden_layers: int = 64 num_attention_heads: int = 80 num_key_value_heads: int | None = 8 hidden_act: str = 'silu' max_position_embeddings: int = 524288 initializer_range: float = 0.02 rms_norm_eps: float = 1e-06 use_cache: bool = True pad_token_id: int | None = 1 bos_token_id: int | None = 0 eos_token_id: int | list[int] | None = 2 pretraining_tp: int = 1 tie_word_embeddings: bool = False rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = None attention_bias: bool = True attention_out_bias: bool = False attention_dropout: float | int = 0.1 residual_dropout: float | int = 0.1 mlp_bias: bool = False head_dim: int | None = 128 )

参数

  • vocab_size (int, 可选, 默认为 155136) — 模型的词汇表大小。定义了 input_ids 可以表示的不同 token 的数量。
  • hidden_size (int, 可选, 默认为 4096) — 隐藏表示的维度。
  • intermediate_size (int, 可选, 默认为 27648) — MLP 表示的维度。
  • num_hidden_layers (int, 可选, 默认为 64) — Transformer 解码器中的隐藏层数量。
  • num_attention_heads (int, 可选, 默认为 80) — Transformer 解码器中每个注意力层的注意力头数量。
  • num_key_value_heads (int, 可选, 默认为 8) — 这是用于实现分组查询注意力(Grouped Query Attention, GQA)的键值头数量。如果 num_key_value_heads=num_attention_heads,模型将使用多头注意力(MHA);如果 num_key_value_heads=1,模型将使用多查询注意力(MQA);否则使用 GQA。在将多头检查点转换为 GQA 检查点时,每个组的键和值头应通过对该组内的所有原始头进行均值池化(mean pooling)来构建。更多详情,请查看 这篇论文。如果未指定,将默认为 num_attention_heads
  • hidden_act (str, 可选, 默认为 silu) — 解码器中的非线性激活函数(函数或字符串)。例如:"gelu", "relu", "silu" 等。
  • max_position_embeddings (int, 可选, 默认为 524288) — 该模型可能使用的最大序列长度。
  • initializer_range (float, 可选, 默认为 0.02) — 用于初始化所有权重矩阵的截断正态初始化器(truncated_normal_initializer)的标准差。
  • rms_norm_eps (float, 可选, 默认为 1e-06) — RMS 归一化层使用的 epsilon 值。
  • use_cache (bool, 可选, 默认为 True) — 模型是否应该返回最后的键/值注意力(并非所有模型都使用)。仅在 config.is_decoder=True 或模型是纯解码器生成模型时相关。
  • pad_token_id (int, 可选, 默认为 1) — 词汇表中用于填充(padding)的 token id。
  • bos_token_id (int, 可选, 默认为 0) — 词汇表中用于流开始(beginning-of-stream)的 token id。
  • eos_token_id (Union[int, list[int]], 可选, 默认为 2) — 词汇表中用于流结束(end-of-stream)的 token id。
  • pretraining_tp (int, 可选, 默认为 1) — 实验性功能。预训练期间使用的张量并行(tensor parallelism)等级。请参阅 此文档 以深入了解。该值对于确保预训练结果的完全可复现性是必要的。请参阅 此 issue
  • tie_word_embeddings (bool, 可选, 默认为 False) — 是否根据模型绑定的 tied_weights_keys 映射来绑定权重嵌入。
  • rope_parameters (Union[~modeling_rope_utils.RopeParameters, dict], 可选) — 包含 RoPE 嵌入配置参数的字典。该字典应包含 rope_theta 的值,并在你想配合更长的 max_position_embeddings 使用 RoPE 时,可选地包含缩放参数。
  • attention_bias (bool, 可选, 默认为 True) — 在自注意力机制期间,是否在查询、键、值和输出投影层中使用偏置(bias)。
  • attention_out_bias (bool, 可选, 默认为 False) — 在自注意力机制期间,是否在输出投影层中使用偏置(bias)。
  • attention_dropout (Union[float, int], 可选, 默认为 0.1) — 注意力概率的丢弃(dropout)比率。
  • residual_dropout (Union[float, int], 可选, 默认为 0.1) — 嵌入、编码器和池化层中所有全连接层的丢弃概率。
  • mlp_bias (bool, optional, defaults to False) — 是否在 MLP 层中的 up_proj、down_proj 和 gate_proj 层中使用偏置 (bias)。
  • head_dim (int, optional, defaults to 128) — 注意力头维度。如果为 None,则默认为 hidden_size // num_attention_heads。

这是用于存储 SeedOssModel 配置的配置类。它根据指定的参数实例化 Seed Oss 模型,并定义模型架构。使用默认值实例化配置将产生与 ByteDance-Seed/Seed-OSS-36B-Instruct 类似的配置。

配置对象继承自 PreTrainedConfig,可用于控制模型输出。阅读 PreTrainedConfig 的文档以获取更多信息。

>>> from transformers import SeedOssModel, SeedOssConfig

>>> # Initializing a SeedOss-36b style configuration
>>> configuration = SeedOssConfig()

>>> # Initializing a model from the SeedOss-36b style configuration
>>> model = SeedOssModel(configuration)

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

SeedOssModel

class transformers.SeedOssModel

< >

( config: SeedOssConfig )

参数

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

裸的 Seed Oss 模型,输出原始隐藏状态,顶部没有任何特定的头部。

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

此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它,并参考 PyTorch 文档了解一般用法和行为的所有相关信息。

forward

< >

( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None use_cache: bool | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) BaseModelOutputWithPasttuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 词汇表中输入序列标记的索引。默认情况下,填充 (padding) 将被忽略。

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

    什么是 input IDs?

  • attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — 用于避免对填充标记索引执行注意力机制的掩码。掩码值在 [0, 1] 中选择:

    • 1 表示未被掩码的标记,
    • 0 表示被掩码的标记。

    什么是 attention masks?

  • position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 每个输入序列标记在位置嵌入中的位置索引。在范围 [0, config.n_positions - 1] 中选择。

    什么是 position IDs?

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

    仅允许输入 Cache 实例,请参阅我们的 kv 缓存指南。如果未传递 past_key_values,将默认初始化 DynamicCache

    模型将输出与输入格式相同的缓存格式。

    如果使用 past_key_values,用户应仅输入形状为 (batch_size, unprocessed_length) 的未处理 input_ids(即未将其之前的键值状态提供给该模型的输入),而不是形状为 (batch_size, sequence_length) 的所有 input_ids

  • inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 可选地,你可以选择直接传递嵌入表示,而不是传递 input_ids。这在你想比模型内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联向量时非常有用。
  • use_cache (bool, optional) — 如果设置为 True,将返回 past_key_values 键值状态,并可用于加速解码(参见 past_key_values)。

返回

BaseModelOutputWithPasttuple(torch.FloatTensor)

一个 BaseModelOutputWithPast 或一个 torch.FloatTensor 元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),根据配置 (SeedOssConfig) 和输入包含各种元素。

SeedOssModel 的 forward 方法,重写了 __call__ 特殊方法。

虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用 Module 实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。

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

    如果使用了 past_key_values,则只输出形状为 (batch_size, 1, hidden_size) 的序列的最后一个隐藏状态。

  • past_key_values (Cache,*可选*,当传入 use_cache=Trueconfig.use_cache=True 时返回) — 这是一个 Cache 实例。欲了解更多细节,请参阅我们的 KV 缓存指南

    Contains pre-computed hidden-states (key and values in the self-attention blocks and optionally if config.is_encoder_decoder=True in the cross-attention blocks) that can be used (see past_key_values input) to speed up sequential decoding.

  • hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入层的输出,如果模型有嵌入层;+一个用于每个层的输出),形状为 (batch_size, sequence_length, hidden_size)

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

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

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

SeedOssForCausalLM

class transformers.SeedOssForCausalLM

< >

( config model_args: ~utils.generic.ModelArgs | None = None adapter_args: ~utils.generic.AdapterArgs | None = None lora_args: ~utils.generic.LoRAArgs | None = None tokenizer_args: ~utils.generic.TokenizerArgs | None = None dataset_args: ~utils.generic.DatasetArgs | None = None data_args: ~utils.generic.DataArgs | None = None training_args: ~utils.generic.TrainingArgs | None = None generation_args: ~utils.generic.GenerationArgs | None = None vision_tower_args: ~utils.generic.VisionTowerArgs | None = None qlora_args: ~utils.generic.QLoRAArgs | None = None vision_tower_template_args: ~utils.generic.VisionTowerTemplateArgs | None = None video_tower_args: ~utils.generic.VideoTowerArgs | None = None vision_config: ~utils.generic.VisionConfig | None = None video_config: ~utils.generic.VideoConfig | None = None load_dataset: bool | None = None load_data_collator: bool | None = None load_processor: bool | None = None load_lora_adapter: bool | None = None load_adapter: bool | None = None load_qlora_adapter: bool | None = None **kwargs: typing_extensions.Unpack[transformers.modeling_utils.PreTrainedModelKwargs] )

参数

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

用于因果语言建模的 Seed Oss 模型。

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

此模型也是一个 PyTorch torch.nn.Module 子类。像普通的 PyTorch Module 一样使用它,并参考 PyTorch 文档了解一般用法和行为的所有相关信息。

forward

< >

( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None use_cache: bool | None = None logits_to_keep: int | torch.Tensor = 0 **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) CausalLMOutputWithPast or tuple(torch.FloatTensor)

参数

  • input_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 词汇表中输入序列标记的索引。默认情况下,填充 (padding) 将被忽略。

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

    什么是 input IDs?

  • attention_mask (torch.Tensor of shape (batch_size, sequence_length), optional) — 用于避免对填充标记索引执行注意力机制的掩码。掩码值在 [0, 1] 中选择:

    • 1 表示未被掩码的标记,
    • 0 表示被掩码的标记。

    什么是 attention masks?

  • position_ids (torch.LongTensor of shape (batch_size, sequence_length), optional) — 每个输入序列标记在位置嵌入中的位置索引。在范围 [0, config.n_positions - 1] 中选择。

    什么是 position IDs?

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

    仅允许输入 Cache 实例,请参阅我们的 kv 缓存指南。如果未传递 past_key_values,将默认初始化 DynamicCache

    模型将输出与输入格式相同的缓存格式。

    如果使用 past_key_values,用户应仅输入形状为 (batch_size, unprocessed_length) 的未处理 input_ids(即未将其之前的键值状态提供给该模型的输入),而不是形状为 (batch_size, sequence_length) 的所有 input_ids

  • inputs_embeds (torch.FloatTensor of shape (batch_size, sequence_length, hidden_size), optional) — 可选地,你可以选择直接传递嵌入表示,而不是传递 input_ids。这在你想比模型内部嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为关联向量时非常有用。
  • labels (torch.LongTensor of shape (batch_size, sequence_length), optional) — 用于计算掩码语言建模损失的标签。索引应在 [0, ..., config.vocab_size] 中或为 -100(请参阅 input_ids 文档字符串)。索引设置为 -100 的标记将被忽略(掩码),损失仅针对标签在 [0, ..., config.vocab_size] 中的标记计算。
  • use_cache (bool, optional) — 如果设置为 True,将返回 past_key_values 键值状态,并可用于加速解码(参见 past_key_values)。
  • logits_to_keep (Union[int, torch.Tensor], optional, defaults to 0) — 如果为 int,则计算最后 logits_to_keep 个标记的对数几率 (logits)。如果为 0,则计算所有 input_ids 的对数几率(特殊情况)。生成时仅需要最后一个标记的对数几率,仅针对该标记计算它们可以节省内存,这对于长序列或大词汇表大小来说非常重要。如果为 torch.Tensor,则必须是对应于序列长度维度中要保留索引的一维张量。这在使用打包张量格式(批次和序列长度的单一维度)时非常有用。

返回

CausalLMOutputWithPast or tuple(torch.FloatTensor)

一个 CausalLMOutputWithPast 或一个 torch.FloatTensor 元组(如果传递了 return_dict=False 或当 config.return_dict=False 时),根据配置 (SeedOssConfig) 和输入包含各种元素。

SeedOssForCausalLM 的 forward 方法,重写了 __call__ 特殊方法。

虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用 Module 实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。

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

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

  • past_key_values (Cache,*可选*,当传入 use_cache=Trueconfig.use_cache=True 时返回) — 这是一个 Cache 实例。欲了解更多细节,请参阅我们的 KV 缓存指南

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

  • hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入层的输出,如果模型有嵌入层;+一个用于每个层的输出),形状为 (batch_size, sequence_length, hidden_size)

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

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

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

示例

>>> from transformers import AutoTokenizer, SeedOssForCausalLM

>>> model = SeedOssForCausalLM.from_pretrained("ByteDance-Seed/Seed-OSS-36B-Instruct")
>>> tokenizer = AutoTokenizer.from_pretrained("ByteDance-Seed/Seed-OSS-36B-Instruct")

>>> 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."

SeedOssForSequenceClassification

class transformers.SeedOssForSequenceClassification

< >

( config )

forward

< >

( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None use_cache: bool | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) SequenceClassifierOutputWithPast or tuple(torch.FloatTensor)

参数

  • input_ids (形状为 (batch_size, sequence_length)torch.LongTensor可选) — 词表中输入序列标记的索引。默认情况下将忽略填充(Padding)。

    索引可以通过 AutoTokenizer 获取。有关详细信息,请参见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是 input IDs?

  • attention_mask (形状为 (batch_size, sequence_length)torch.Tensor可选) — 用于避免对填充标记索引执行注意力计算的掩码。掩码值选自 [0, 1]

    • 1 表示 未掩码 的标记,
    • 0 表示 已掩码 的标记。

    什么是 attention masks?

  • position_ids (形状为 (batch_size, sequence_length)torch.LongTensor可选) — 每个输入序列标记在位置嵌入中的位置索引。选自范围 [0, config.n_positions - 1]

    什么是 position IDs?

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

    仅允许输入 Cache 实例,请参阅我们的 kv 缓存指南。如果不传递 past_key_values,则默认初始化 DynamicCache

    模型将输出与输入时相同的缓存格式。

    如果使用了 past_key_values,则用户仅需输入未处理的 input_ids(即那些没有给出过去键值状态的输入),其形状为 (batch_size, unprocessed_length),而不是所有 input_ids(形状为 (batch_size, sequence_length))。

  • inputs_embeds (形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor可选) — 可选地,你可以选择直接传递嵌入表示,而不是传递 input_ids。如果你想比模型内部的嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为相关的向量,这非常有用。
  • labels (形状为 (batch_size, sequence_length)torch.LongTensor可选) — 用于计算掩码语言建模损失的标签。索引应在 [0, ..., config.vocab_size] 范围内或为 -100(请参阅 input_ids 文档字符串)。索引设置为 -100 的标记将被忽略(掩码),损失仅针对标签在 [0, ..., config.vocab_size] 范围内的标记进行计算。
  • use_cache (bool可选) — 如果设置为 True,则返回 past_key_values 键值状态,并可用于加速解码(参见 past_key_values)。

返回

SequenceClassifierOutputWithPasttuple(torch.FloatTensor)

一个 SequenceClassifierOutputWithPasttorch.FloatTensor 元组(如果传入了 return_dict=False 或当 config.return_dict=False 时),根据配置(None)和输入,其包含不同的元素。

The GenericForSequenceClassification forward method, overrides the __call__ special method.

虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用 Module 实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。

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

  • logits (形状为 (batch_size, config.num_labels)torch.FloatTensor) — 分类(如果 config.num_labels==1,则为回归)分数(SoftMax 之前)。

  • past_key_values (Cache,*可选*,当传入 use_cache=Trueconfig.use_cache=True 时返回) — 这是一个 Cache 实例。欲了解更多细节,请参阅我们的 KV 缓存指南

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

  • hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入层的输出,如果模型有嵌入层;+一个用于每个层的输出),形状为 (batch_size, sequence_length, hidden_size)

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

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

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

SeedOssForTokenClassification

class transformers.SeedOssForTokenClassification

< >

( config )

forward

< >

( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None labels: torch.LongTensor | None = None use_cache: bool | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) TokenClassifierOutputtuple(torch.FloatTensor)

参数

  • input_ids (形状为 (batch_size, sequence_length)torch.LongTensor可选) — 词表中输入序列标记的索引。默认情况下将忽略填充(Padding)。

    索引可以通过 AutoTokenizer 获取。有关详细信息,请参见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是 input IDs?

  • attention_mask (形状为 (batch_size, sequence_length)torch.Tensor可选) — 用于避免对填充标记索引执行注意力计算的掩码。掩码值选自 [0, 1]

    • 1 表示 未掩码 的标记,
    • 0 表示 已掩码 的标记。

    什么是 attention masks?

  • position_ids (形状为 (batch_size, sequence_length)torch.LongTensor可选) — 每个输入序列标记在位置嵌入中的位置索引。选自范围 [0, config.n_positions - 1]

    什么是 position IDs?

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

    仅允许输入 Cache 实例,请参阅我们的 kv 缓存指南。如果不传递 past_key_values,则默认初始化 DynamicCache

    模型将输出与输入时相同的缓存格式。

    如果使用了 past_key_values,则用户仅需输入未处理的 input_ids(即那些没有给出过去键值状态的输入),其形状为 (batch_size, unprocessed_length),而不是所有 input_ids(形状为 (batch_size, sequence_length))。

  • inputs_embeds (形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor可选) — 可选地,你可以选择直接传递嵌入表示,而不是传递 input_ids。如果你想比模型内部的嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为相关的向量,这非常有用。
  • labels (形状为 (batch_size, sequence_length)torch.LongTensor可选) — 用于计算掩码语言建模损失的标签。索引应在 [0, ..., config.vocab_size] 范围内或为 -100(请参阅 input_ids 文档字符串)。索引设置为 -100 的标记将被忽略(掩码),损失仅针对标签在 [0, ..., config.vocab_size] 范围内的标记进行计算。
  • use_cache (bool可选) — 如果设置为 True,则返回 past_key_values 键值状态,并可用于加速解码(参见 past_key_values)。

返回

TokenClassifierOutputtuple(torch.FloatTensor)

一个 TokenClassifierOutputtorch.FloatTensor 元组(如果传递了 return_dict=Falseconfig.return_dict=False),包含取决于配置 (None) 和输入的各种元素。

The GenericForTokenClassification forward method, overrides the __call__ special method.

虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用 Module 实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。

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

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

  • hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入层的输出,如果模型有嵌入层;+一个用于每个层的输出),形状为 (batch_size, sequence_length, hidden_size)

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

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

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

SeedOssForQuestionAnswering

class transformers.SeedOssForQuestionAnswering

< >

( config )

forward

< >

( input_ids: torch.LongTensor | None = None attention_mask: torch.Tensor | None = None position_ids: torch.LongTensor | None = None past_key_values: transformers.cache_utils.Cache | None = None inputs_embeds: torch.FloatTensor | None = None start_positions: torch.LongTensor | None = None end_positions: torch.LongTensor | None = None **kwargs: typing_extensions.Unpack[transformers.utils.generic.TransformersKwargs] ) QuestionAnsweringModelOutputtuple(torch.FloatTensor)

参数

  • input_ids (形状为 (batch_size, sequence_length)torch.LongTensor可选) — 词表中输入序列标记的索引。默认情况下将忽略填充(Padding)。

    索引可以通过 AutoTokenizer 获取。有关详细信息,请参见 PreTrainedTokenizer.encode()PreTrainedTokenizer.call()

    什么是 input IDs?

  • attention_mask (形状为 (batch_size, sequence_length)torch.Tensor可选) — 用于避免对填充标记索引执行注意力计算的掩码。掩码值选自 [0, 1]

    • 1 表示 未掩码 的标记,
    • 0 表示 已掩码 的标记。

    什么是 attention masks?

  • position_ids (形状为 (batch_size, sequence_length)torch.LongTensor可选) — 每个输入序列标记在位置嵌入中的位置索引。选自范围 [0, config.n_positions - 1]

    什么是 position IDs?

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

    仅允许输入 Cache 实例,请参阅我们的 kv 缓存指南。如果不传递 past_key_values,则默认初始化 DynamicCache

    模型将输出与输入时相同的缓存格式。

    如果使用了 past_key_values,则用户仅需输入未处理的 input_ids(即那些没有给出过去键值状态的输入),其形状为 (batch_size, unprocessed_length),而不是所有 input_ids(形状为 (batch_size, sequence_length))。

  • inputs_embeds (形状为 (batch_size, sequence_length, hidden_size)torch.FloatTensor可选) — 可选地,你可以选择直接传递嵌入表示,而不是传递 input_ids。如果你想比模型内部的嵌入查找矩阵更精细地控制如何将 input_ids 索引转换为相关的向量,这非常有用。
  • start_positions (形状为 (batch_size,)torch.LongTensor可选) — 用于计算标记分类损失的标签跨度起始位置(索引)。位置被截断为序列的长度(sequence_length)。序列之外的位置不计入损失计算。
  • end_positions (torch.LongTensor,形状为 (batch_size,)可选) — 用于计算标记分类损失的标注片段结束位置(索引)标签。位置会被截断至序列长度 (sequence_length)。序列之外的位置在计算损失时不会被计入。

返回

QuestionAnsweringModelOutputtuple(torch.FloatTensor)

一个 QuestionAnsweringModelOutputtorch.FloatTensor 元组(如果传递了 return_dict=Falseconfig.return_dict=False),包含取决于配置 (None) 和输入的各种元素。

The GenericForQuestionAnswering forward method, overrides the __call__ special method.

虽然 forward pass 的实现需要在此函数中定义,但你应该在之后调用 Module 实例而不是这个,因为前者负责运行预处理和后处理步骤,而后者会静默地忽略它们。

  • loss (torch.FloatTensor of shape (1,), 可选, 当提供 labels 时返回) — 总范围提取损失是起始位置和结束位置的交叉熵之和。

  • start_logits (torch.FloatTensor of shape (batch_size, sequence_length)) — 范围起始分数(SoftMax 之前)。

  • end_logits (torch.FloatTensor of shape (batch_size, sequence_length)) — 范围结束分数(SoftMax 之前)。

  • hidden_states (tuple(torch.FloatTensor), optional, 当传递 output_hidden_states=True 或当 config.output_hidden_states=True 时返回) — torch.FloatTensor 的元组(一个用于嵌入层的输出,如果模型有嵌入层;+一个用于每个层的输出),形状为 (batch_size, sequence_length, hidden_size)

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

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

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

在 GitHub 上更新

© . This site is unofficial and not affiliated with Hugging Face, Inc.