Transformers 4.37 中文文档（六十二）（5）

Transformers 4.37 中文文档（六十二）（4）https://developer.aliyun.com/article/1564099

FlaxXLMRobertaModel

class transformers.FlaxXLMRobertaModel

<来源>

( config: XLMRobertaConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

参数

• config（XLMRobertaConfig）— 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只加载配置。查看 from_pretrained()方法以加载模型权重。

裸 XLM RoBERTa 模型变换器输出原始隐藏状态，没有特定的头部。

此模型继承自 FlaxPreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如从 PyTorch 模型下载、保存和转换权重）

此模型还是flax.linen.Module子类。将其用作常规 Flax 亚麻模块，并参考 Flax 文档以了解与一般用法和行为相关的所有事项。

最后，此模型支持内在的 JAX 功能，例如：

• 即将（JIT）编译
  
• 自动微分
  
• 矢量化
  
• 并行化
  

__call__

<来源>

( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None past_key_values: dict = None ) → export const metadata = 'undefined';transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPooling or tuple(torch.FloatTensor)

参数

• input_ids（形状为(batch_size, sequence_length)的numpy.ndarray）— 词汇表中输入序列令牌的索引。
  可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。
  输入 ID 是什么？
  
• attention_mask（形状为(batch_size, sequence_length)的numpy.ndarray，可选）— 避免在填充令牌索引上执行注意力的掩码。掩码值选择在[0, 1]中：

• 1 表示未屏蔽的令牌，
  
• 0 表示屏蔽的令牌。
  

• 注意力掩码是什么？
  
• token_type_ids（形状为(batch_size, sequence_length)的numpy.ndarray，可选）— 段令牌索引，指示输入的第一部分和第二部分。索引选择在[0, 1]中：

• 0 对应于句子 A令牌，
  
• 1 对应于句子 B令牌。
  

• 令牌类型 ID 是什么？
  
• position_ids（形状为(batch_size, sequence_length)的numpy.ndarray，可选）— 每个输入序列令牌在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。
  
• head_mask (numpy.ndarray，形状为(batch_size, sequence_length)，可选) – 用于使注意力模块中选择的头部失效的掩码。掩码值选择在[0, 1]之间：

• 1 表示头部未被掩蔽，
  
• 0 表示头部被掩蔽。
  

• return_dict (bool，可选) — 是否返回一个 ModelOutput 而不是一个普通的元组。
  

返回

transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPooling 或 tuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPooling 或一个torch.FloatTensor元组（如果传递return_dict=False或config.return_dict=False）包括根据配置(XLMRobertaConfig)和输入的不同元素。

• last_hidden_state (jnp.ndarray，形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层的隐藏状态序列。
  
• pooler_output (jnp.ndarray，形状为(batch_size, hidden_size)) — 序列的第一个标记（分类标记）的最后一层隐藏状态，进一步由一个线性层和一个 Tanh 激活函数处理。线性层的权重是在预训练期间从下一个句子预测（分类）目标中训练的。
  
• hidden_states (tuple(jnp.ndarray)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的jnp.ndarray元组（一个用于嵌入的输出 + 一个用于每一层的输出）。
  模型在每一层输出的隐藏状态加上初始嵌入输出。
  
• attentions (tuple(jnp.ndarray)，可选，当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的jnp.ndarray元组（每一层一个）。
  注意力权重在注意力 softmax 之后，用于计算自注意力头中的加权平均值。
  

FlaxXLMRobertaPreTrainedModel的前向方法，覆盖了__call__特殊方法。

虽然前向传递的步骤需要在此函数内定义，但应该在之后调用Module实例，而不是这个，因为前者会处理运行前后处理步骤，而后者会默默地忽略它们。

示例：

>>> from transformers import AutoTokenizer, FlaxXLMRobertaModel
>>> tokenizer = AutoTokenizer.from_pretrained("xlm-roberta-base")
>>> model = FlaxXLMRobertaModel.from_pretrained("xlm-roberta-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_state

FlaxXLMRobertaForCausalLM

class transformers.FlaxXLMRobertaForCausalLM

<来源>

( config: XLMRobertaConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

参数

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

XLM Roberta 模型在顶部带有语言建模头（隐藏状态输出的顶部的线性层），例如用于自回归任务。

该模型继承自 FlaxPreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（如从 PyTorch 模型下载、保存和转换权重）。

此模型还是一个flax.linen.Module子类。将其用作常规的 Flax 亚麻模块，并参考 Flax 文档以获取有关一般用法和行为的所有相关信息。

最后，此模型支持 JAX 的固有特性，例如：

• 即时（JIT）编译
  
• 自动微分
  
• 矢量化
  
• 并行化
  

__call__

<来源>

( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None past_key_values: dict = None ) → export const metadata = 'undefined';transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions or tuple(torch.FloatTensor)

参数

• input_ids（形状为(batch_size, sequence_length)的numpy.ndarray）- 词汇表中输入序列标记的索引。
  可以使用 AutoTokenizer 来获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。
  什么是输入 ID？
  
• attention_mask（形状为(batch_size, sequence_length)的numpy.ndarray，可选）- 用于避免在填充标记索引上执行注意力的掩码。掩码值在[0, 1]中选择：

• 1 表示未被masked的标记，
  
• 0 表示被masked的标记。
  

• 什么是注意力掩码？
  
• token_type_ids（形状为(batch_size, sequence_length)的numpy.ndarray，可选）- 段标记索引，用于指示输入的第一部分和第二部分。索引在[0, 1]中选择：

• 0 对应于句子 A标记，
  
• 1 对应于句子 B标记。
  

• 什么是标记类型 ID？
  
• position_ids（形状为(batch_size, sequence_length)的numpy.ndarray，可选）- 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。
  
• head_mask（形状为(batch_size, sequence_length)的numpy.ndarray，可选）- 用于使注意力模块中选择的头部失效的掩码。掩码值在[0, 1]中选择：

• 1 表示头部未被masked，
  
• 0 表示头部被masked。
  

• return_dict（bool，可选）- 是否返回 ModelOutput 而不是普通元组。
  

返回

transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或tuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxCausalLMOutputWithCrossAttentions 或一个torch.FloatTensor元组（如果传递了return_dict=False或config.return_dict=False）包括根据配置（XLMRobertaConfig）和输入的各种元素。

• 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元组（一个用于嵌入的输出 + 一个用于每个层的输出）。
  模型在每层输出的隐藏状态加上初始嵌入输出。
  
• attentions（tuple(jnp.ndarray)，可选，当传递output_attentions=True或config.output_attentions=True时返回）- 形状为(batch_size, num_heads, sequence_length, sequence_length)的jnp.ndarray元组（每层一个）。
  在注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
  
• cross_attentions（tuple(jnp.ndarray)，可选，当传递output_attentions=True或config.output_attentions=True时返回）- 形状为(batch_size, num_heads, sequence_length, sequence_length)的jnp.ndarray元组（每层一个）。
  在注意力 softmax 之后的交叉注意力权重，用于计算交叉注意力头中的加权平均值。
  
• past_key_values（tuple(tuple(jnp.ndarray))，可选，当传递use_cache=True或config.use_cache=True时返回）- 长度为config.n_layers的jnp.ndarray元组的元组，每个元组包含自注意力和交叉注意力层的缓存键、值状态，如果模型用于编码器-解码器设置，则相关。仅在config.is_decoder = True时相关。
  包含预先计算的隐藏状态（注意力块中的键和值），可用于加速顺序解码。
  

FlaxXLMRobertaPreTrainedModel的前向方法覆盖了__call__特殊方法。

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

示例：

>>> from transformers import AutoTokenizer, FlaxXLMRobertaForCausalLM
>>> tokenizer = AutoTokenizer.from_pretrained("xlm-roberta-base")
>>> model = FlaxXLMRobertaForCausalLM.from_pretrained("xlm-roberta-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="np")
>>> outputs = model(**inputs)
>>> # retrieve logts for next token
>>> next_token_logits = outputs.logits[:, -1]

FlaxXLMRobertaForMaskedLM

class transformers.FlaxXLMRobertaForMaskedLM

<来源>

( config: XLMRobertaConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

参数

• config（XLMRobertaConfig）- 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只加载配置。查看 from_pretrained()方法以加载模型权重。

带有顶部语言建模头的 XLM RoBERTa 模型。

此模型继承自 FlaxPreTrainedModel。查看超类文档以了解库为所有模型实现的通用方法（例如从 PyTorch 模型下载、保存和转换权重）。

此模型还是flax.linen.Module子类。将其用作常规的 Flax linen 模块，并参考 Flax 文档以了解所有与一般用法和行为相关的事项。

最后，此模型支持内在的 JAX 特性，例如：

• 即时（JIT）编译
  
• 自动微分
  
• 矢量化
  
• 并行化
  

__call__

<来源>

( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None past_key_values: dict = None ) → export const metadata = 'undefined';transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPooling or tuple(torch.FloatTensor)

参数

• input_ids（形状为(batch_size, sequence_length)的numpy.ndarray）- 词汇表中输入序列标记的索引。
  可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。
  什么是输入 IDs？
  
• attention_mask (numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 避免在填充标记索引上执行注意力的掩码。掩码值选择在[0, 1]中：

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

• 什么是注意力掩码？
  
• token_type_ids (numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 指示输入的第一部分和第二部分的段标记索引。索引在[0, 1]中选择：

• 0 对应于一个句子 A的标记，
  
• 1 对应于一个句子 B的标记。
  

• 什么是 token type IDs？
  
• position_ids (numpy.ndarray，形状为(batch_size, sequence_length)，可选) — 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。
  
• head_mask (numpy.ndarray，形状为(batch_size, sequence_length)，可选) -- 用于使注意力模块中选择的头部失效的掩码。掩码值选择在[0, 1]`中：

• 1 表示头部未被掩码，
  
• 0 表示头部被掩码。
  

• return_dict (bool，可选) — 是否返回一个 ModelOutput 而不是一个普通元组。
  

返回

transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPooling 或者tuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxBaseModelOutputWithPooling 或者一个torch.FloatTensor元组（如果传递return_dict=False或者config.return_dict=False）包含根据配置（XLMRobertaConfig）和输入而异的各种元素。

• last_hidden_state (jnp.ndarray，形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层输出的隐藏状态序列。
  
• pooler_output (jnp.ndarray，形状为(batch_size, hidden_size)) — 序列第一个标记（分类标记）的最后一层隐藏状态，进一步由一个线性层和一个 Tanh 激活函数处理。线性层的权重是在预训练期间从下一个句子预测（分类）目标中训练的。
  
• hidden_states (tuple(jnp.ndarray)，可选，当传递output_hidden_states=True或者config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的jnp.ndarray元组（一个用于嵌入的输出 + 一个用于每一层的输出）。
  模型在每一层输出的隐藏状态加上初始嵌入输出。
  
• attentions (tuple(jnp.ndarray), 可选, 当传递output_attentions=True或者config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的jnp.ndarray元组（每层一个）。
  在自注意力头中用于计算加权平均值的注意力 softmax 后的注意力权重。
  

FlaxXLMRobertaPreTrainedModel的前向方法，覆盖了__call__特殊方法。

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

示例：

>>> from transformers import AutoTokenizer, FlaxXLMRobertaForMaskedLM
>>> tokenizer = AutoTokenizer.from_pretrained("xlm-roberta-base")
>>> model = FlaxXLMRobertaForMaskedLM.from_pretrained("xlm-roberta-base")
>>> inputs = tokenizer("The capital of France is [MASK].", return_tensors="jax")
>>> outputs = model(**inputs)
>>> logits = outputs.logits

FlaxXLMRobertaForSequenceClassification

class transformers.FlaxXLMRobertaForSequenceClassification

< source >

( config: XLMRobertaConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

参数

• config（XLMRobertaConfig）— 包含模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只加载配置。查看 from_pretrained() 方法以加载模型权重。

XLM Roberta 模型变压器，顶部带有一个序列分类/回归头（在汇总输出的顶部有一个线性层），例如用于 GLUE 任务。

这个模型继承自 FlaxPreTrainedModel。查看超类文档以获取库为所有模型实现的通用方法（如下载、保存和从 PyTorch 模型转换权重）。

这个模型也是一个 flax.linen.Module 的子类。将其用作常规的 Flax linen 模块，并参考 Flax 文档以获取有关一般用法和行为的所有相关信息。

最后，这个模型支持内置的 JAX 特性，比如：

• 即时（JIT）编译
  
• 自动微分
  
• 向量化
  
• 并行化
  

__call__

< source >

( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None past_key_values: dict = None ) → export const metadata = 'undefined';transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput or tuple(torch.FloatTensor)

参数

• input_ids（形状为 (batch_size, sequence_length) 的 numpy.ndarray）— 词汇表中输入序列标记的索引。
  可以使用 AutoTokenizer 获取索引。查看 PreTrainedTokenizer.encode() 和 PreTrainedTokenizer.call() 以获取详细信息。
  什么是输入 ID？
  
• attention_mask（形状为 (batch_size, sequence_length) 的 numpy.ndarray，可选）— 避免在填充标记索引上执行注意力的掩码。掩码值在 [0, 1] 中选择：

• 1 用于 未被掩盖 的标记，
  
• 0 用于 被掩盖 的标记。
  

• 什么是注意力掩码？
  
• token_type_ids（形状为 (batch_size, sequence_length) 的 numpy.ndarray，可选）— 指示输入的第一部分和第二部分的段标记索引。索引在 [0, 1] 中选择：

• 0 对应于 句子 A 的标记，
  
• 1 对应于 句子 B 的标记。
  

• 什么是标记类型 ID？
  
• position_ids（形状为 (batch_size, sequence_length) 的 numpy.ndarray，可选）— 每个输入序列标记在位置嵌入中的位置索引。在范围 [0, config.max_position_embeddings - 1] 中选择。
  
• head_mask（形状为 (batch_size, sequence_length) 的 numpy.ndarray，可选）-- 用于使注意力模块的选定头部无效的掩码。掩码值在 [0, 1]` 中选择：

• 1 表示头部 未被掩盖，
  
• 0 表示头部 被掩盖。
  

• return_dict（bool，可选）- 是否返回 ModelOutput 而不是普通元组。
  

返回

transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或tuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxSequenceClassifierOutput 或一个torch.FloatTensor元组（如果传递return_dict=False或config.return_dict=False时）包含根据配置（XLMRobertaConfig）和输入的各种元素。

• logits（形状为(batch_size, config.num_labels)的jnp.ndarray）- 分类（如果 config.num_labels==1 则为回归）得分（SoftMax 之前）。
  
• hidden_states（tuple(jnp.ndarray)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回）- 形状为(batch_size, sequence_length, hidden_size)的jnp.ndarray元组（一个用于嵌入的输出+一个用于每层的输出）。
  模型在每层输出的隐藏状态以及初始嵌入输出。
  
• attentions（tuple(jnp.ndarray)，可选，当传递output_attentions=True或config.output_attentions=True时返回）- 形状为(batch_size, num_heads, sequence_length, sequence_length)的jnp.ndarray元组（每层一个）。
  注意力权重在注意力 softmax 之后，用于计算自注意力头中的加权平均值。
  

FlaxXLMRobertaPreTrainedModel的前向方法覆盖了__call__特殊方法。

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

示例：

>>> from transformers import AutoTokenizer, FlaxXLMRobertaForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("xlm-roberta-base")
>>> model = FlaxXLMRobertaForSequenceClassification.from_pretrained("xlm-roberta-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> logits = outputs.logits

FlaxXLMRobertaForMultipleChoice

class transformers.FlaxXLMRobertaForMultipleChoice

<来源>

( config: XLMRobertaConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

参数

• config（XLMRobertaConfig）- 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型相关的权重，只加载配置。查看 from_pretrained()方法以加载模型权重。

XLM Roberta 模型，顶部带有多选分类头（池化输出顶部的线性层和 Softmax），例如用于 RocStories/SWAG 任务。

此模型继承自 FlaxPreTrainedModel。检查超类文档以了解库为所有模型实现的通用方法（例如从 PyTorch 模型下载、保存和转换权重）。

此模型还是一个flax.linen.Module子类。将其用作常规的 Flax linen 模块，并参考 Flax 文档以了解与一般用法和行为相关的所有事项。

最后，此模型支持内在的 JAX 特性，例如：

• 即时（JIT）编译
  
• 自动微分
  
• 矢量化
  
• 并行化
  

__call__

< source >

( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None past_key_values: dict = None ) → export const metadata = 'undefined';transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput or tuple(torch.FloatTensor)

参数

• input_ids (numpy.ndarray of shape (batch_size, num_choices, sequence_length)) — 词汇表中输入序列标记的索引。
  可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。
  什么是 input IDs?
  
• attention_mask (numpy.ndarray of shape (batch_size, num_choices, sequence_length), optional) — 用于避免在填充标记索引上执行注意力的掩码。掩码值选择在[0, 1]中：

• 1 对于未被masked的标记，
  
• 对于被masked的标记为 0。
  

• 什么是 attention masks?
  
• token_type_ids (numpy.ndarray of shape (batch_size, num_choices, sequence_length), optional) — 段标记索引，指示输入的第一部分和第二部分。索引在[0, 1]中选择：

• 0 对应于 sentence A token，
  
• 1 对应于 sentence B token。
  

• 什么是 token type IDs?
  
• position_ids (numpy.ndarray of shape (batch_size, num_choices, sequence_length), optional) — 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。
  
• head_mask (numpy.ndarray of shape (batch_size, num_choices, sequence_length), optional) -- 用于使注意力模块中的选定头部失效的掩码。掩码值选择在[0, 1]`中：

• 1 表示头部未被masked，
  
• 0 表示头部被masked。
  

• return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通元组。
  

返回

transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput 或tuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxMultipleChoiceModelOutput 或一个torch.FloatTensor元组（如果传递了return_dict=False或config.return_dict=False时）包含根据配置(XLMRobertaConfig)和输入的各种元素。

• logits (jnp.ndarray of shape (batch_size, num_choices)) — num_choices 是输入张量的第二维。(参见上面的 input_ids)。
  分类分数（SoftMax 之前）。
  
• hidden_states (tuple(jnp.ndarray), optional, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的jnp.ndarray元组（一个用于嵌入输出，一个用于每一层的输出）。
  每一层模型的隐藏状态加上初始嵌入输出。
  
• attentions (tuple(jnp.ndarray), optional, 当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的jnp.ndarray元组（每层一个）。
  在自注意力头中用于计算加权平均值的注意力 softmax 之后的注意力权重。
  

FlaxXLMRobertaPreTrainedModel的前向方法，覆盖__call__特殊方法。

虽然前向传递的配方需要在此函数内定义，但应该在此之后调用Module实例，而不是在此处调用，因为前者会负责运行预处理和后处理步骤，而后者会默默地忽略它们。

示例：

>>> from transformers import AutoTokenizer, FlaxXLMRobertaForMultipleChoice
>>> tokenizer = AutoTokenizer.from_pretrained("xlm-roberta-base")
>>> model = FlaxXLMRobertaForMultipleChoice.from_pretrained("xlm-roberta-base")
>>> prompt = "In Italy, pizza served in formal settings, such as at a restaurant, is presented unsliced."
>>> choice0 = "It is eaten with a fork and a knife."
>>> choice1 = "It is eaten while held in the hand."
>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="jax", padding=True)
>>> outputs = model(**{k: v[None, :] for k, v in encoding.items()})
>>> logits = outputs.logits

FlaxXLMRobertaForTokenClassification

class transformers.FlaxXLMRobertaForTokenClassification

<来源>

( config: XLMRobertaConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

参数

• config（XLMRobertaConfig）— 具有模型所有参数的模型配置类。使用配置文件初始化不会加载与模型关联的权重，只加载配置。查看 from_pretrained()方法以加载模型权重。

XLM Roberta 模型在顶部带有一个标记分类头（在隐藏状态输出的顶部有一个线性层），例如用于命名实体识别（NER）任务。

这个模型继承自 FlaxPreTrainedModel。检查超类文档以获取库为所有模型实现的通用方法（例如从 PyTorch 模型下载、保存和转换权重）

这个模型也是一个flax.linen.Module子类。将其用作常规的 Flax linen 模块，并参考 Flax 文档以获取与一般用法和行为相关的所有内容。

最后，这个模型支持内置的 JAX 特性，比如：

• 即时（JIT）编译
  
• 自动微分
  
• 矢量化
  
• 并行化
  

__call__

<来源>

( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None past_key_values: dict = None ) → export const metadata = 'undefined';transformers.modeling_flax_outputs.FlaxTokenClassifierOutput or tuple(torch.FloatTensor)

参数

• input_ids（形状为(batch_size, sequence_length)的numpy.ndarray）— 词汇表中输入序列标记的索引。
  可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。
  什么是输入 ID？
  
• attention_mask（形状为(batch_size, sequence_length)的numpy.ndarray，可选）— 用于避免在填充标记索引上执行注意力的掩码。掩码值选择在[0, 1]之间：

• 1 表示未被掩盖的标记，
  
• 0 表示被掩盖的标记。
  

• 什么是注意力掩码？
  
• token_type_ids（形状为(batch_size, sequence_length)的numpy.ndarray，可选）— 段标记索引，指示输入的第一部分和第二部分。索引选择在[0, 1]之间：

• 0 对应于一个句子 A标记，
  
• 1 对应于一个句子 B标记。
  

• 什么是标记类型 ID？
  
• position_ids（形状为(batch_size, sequence_length)的numpy.ndarray，可选）— 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。
  
• head_mask（形状为(batch_size, sequence_length)的numpy.ndarray，可选）-- 用于使注意力模块的选定头部无效的掩码。掩码值选择在[0, 1]之间：

• 1 表示头部未被掩盖，
  
• 0 表示头部被掩盖。
  

• return_dict (bool, optional) — 是否返回一个 ModelOutput 而不是一个普通的元组。
  

返回

transformers.modeling_flax_outputs.FlaxTokenClassifierOutput 或者tuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxTokenClassifierOutput 或者一个torch.FloatTensor元组（如果传递return_dict=False或者config.return_dict=False时）包含根据配置(XLMRobertaConfig)和输入不同元素。

• logits (jnp.ndarray，形状为(batch_size, sequence_length, config.num_labels)) — 分类分数（SoftMax 之前）。
  
• hidden_states (tuple(jnp.ndarray), optional, 当传递output_hidden_states=True或者config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的jnp.ndarray元组。
  模型在每一层输出的隐藏状态以及初始嵌入输出。
  
• attentions (tuple(jnp.ndarray), optional, 当传递output_attentions=True或者config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的jnp.ndarray元组。
  注意力 softmax 后的注意力权重，用于计算自注意力头中的加权平均值。
  

FlaxXLMRobertaPreTrainedModel的前向方法覆盖了__call__特殊方法。

虽然前向传递的方法需要在这个函数内定义，但应该在之后调用Module实例而不是这个，因为前者负责运行前处理和后处理步骤，而后者会默默地忽略它们。

示例：

>>> from transformers import AutoTokenizer, FlaxXLMRobertaForTokenClassification
>>> tokenizer = AutoTokenizer.from_pretrained("xlm-roberta-base")
>>> model = FlaxXLMRobertaForTokenClassification.from_pretrained("xlm-roberta-base")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="jax")
>>> outputs = model(**inputs)
>>> logits = outputs.logits

FlaxXLMRobertaForQuestionAnswering

class transformers.FlaxXLMRobertaForQuestionAnswering

< source >

( config: XLMRobertaConfig input_shape: Tuple = (1, 1) seed: int = 0 dtype: dtype = <class 'jax.numpy.float32'> _do_init: bool = True gradient_checkpointing: bool = False **kwargs )

参数

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

XLM Roberta 模型，顶部带有一个用于提取式问答任务（如 SQuAD）的跨度分类头（在隐藏状态输出的顶部有一个线性层，用于计算跨度起始 logits和跨度结束 logits）。

这个模型继承自 FlaxPreTrainedModel。查看超类文档以获取库为所有模型实现的通用方法（如从 PyTorch 模型下载、保存和转换权重）。

这个模型也是一个flax.linen.Module子类。将其用作常规的 Flax linen 模块，并参考 Flax 文档以获取有关一般用法和行为的所有信息。

最后，这个模型支持 JAX 的固有特性，例如：

• 即时编译（JIT）
  
• 自动微分
  
• 矢量化
  
• 并行化
  

__call__

<来源>

( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None past_key_values: dict = None ) → export const metadata = 'undefined';transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutput or tuple(torch.FloatTensor)

参数

• input_ids (numpy.ndarray，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。
  可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。
  什么是输入 ID？
  
• attention_mask (numpy.ndarray，形状为(batch_size, sequence_length)，optional) — 避免在填充标记索引上执行注意力的掩码。掩码值选在[0, 1]：

• 1 表示未被masked的标记，
  
• 0 表示被masked的标记。
  

• 什么是注意力掩码？
  
• token_type_ids (numpy.ndarray，形状为(batch_size, sequence_length)，optional) — 段标记索引，指示输入的第一部分和第二部分。索引选在[0, 1]：

• 0 对应于句子 A标记，
  
• 1 对应于句子 B标记。
  

• 什么是标记类型 ID？
  
• position_ids (numpy.ndarray，形状为(batch_size, sequence_length)，optional) — 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。
  
• head_mask (numpy.ndarray，形状为(batch_size, sequence_length)，optional) -- 用于使注意力模块的选定头部失效的掩码。掩码值选在[0, 1]`：

• 1 表示头部未被masked，
  
• 0 表示头部被masked。
  

• return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通元组。
  

返回

transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutput 或一个torch.FloatTensor元组（如果传递return_dict=False或config.return_dict=False）包含根据配置（XLMRobertaConfig）和输入的各种元素。

• start_logits (jnp.ndarray，形状为(batch_size, sequence_length)) — 跨度起始分数（SoftMax 之前）。
  
• end_logits (jnp.ndarray，形状为(batch_size, sequence_length)) — 跨度结束分数（SoftMax 之前）。
  
• hidden_states (tuple(jnp.ndarray), optional, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的jnp.ndarray元组（一个用于嵌入的输出 + 一个用于每个层的输出）。
  模型在每个层的输出以及初始嵌入输出的隐藏状态。
  
• attentions (tuple(jnp.ndarray), optional, 当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的jnp.ndarray元组。
  在注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
  

FlaxXLMRobertaPreTrainedModel的前向方法，覆盖__call__特殊方法。

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

示例：

>>> from transformers import AutoTokenizer, FlaxXLMRobertaForQuestionAnswering
>>> tokenizer = AutoTokenizer.from_pretrained("xlm-roberta-base")
>>> model = FlaxXLMRobertaForQuestionAnswering.from_pretrained("xlm-roberta-base")
>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="jax")
>>> outputs = model(**inputs)
>>> start_scores = outputs.start_logits
>>> end_scores = outputs.end_logits

和跨度结束 logits）。

这个模型继承自 FlaxPreTrainedModel。查看超类文档以获取库为所有模型实现的通用方法（如从 PyTorch 模型下载、保存和转换权重）。

这个模型也是一个flax.linen.Module子类。将其用作常规的 Flax linen 模块，并参考 Flax 文档以获取有关一般用法和行为的所有信息。

最后，这个模型支持 JAX 的固有特性，例如：

• 即时编译（JIT）
  
• 自动微分
  
• 矢量化
  
• 并行化
  

__call__

<来源>

( input_ids attention_mask = None token_type_ids = None position_ids = None head_mask = None encoder_hidden_states = None encoder_attention_mask = None params: dict = None dropout_rng: PRNGKey = None train: bool = False output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None past_key_values: dict = None ) → export const metadata = 'undefined';transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutput or tuple(torch.FloatTensor)

参数

• input_ids (numpy.ndarray，形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。
  可以使用 AutoTokenizer 获取索引。有关详细信息，请参阅 PreTrainedTokenizer.encode()和 PreTrainedTokenizer.call()。
  什么是输入 ID？
  
• attention_mask (numpy.ndarray，形状为(batch_size, sequence_length)，optional) — 避免在填充标记索引上执行注意力的掩码。掩码值选在[0, 1]：

• 1 表示未被masked的标记，
  
• 0 表示被masked的标记。
  

• 什么是注意力掩码？
  
• token_type_ids (numpy.ndarray，形状为(batch_size, sequence_length)，optional) — 段标记索引，指示输入的第一部分和第二部分。索引选在[0, 1]：

• 0 对应于句子 A标记，
  
• 1 对应于句子 B标记。
  

• 什么是标记类型 ID？
  
• position_ids (numpy.ndarray，形状为(batch_size, sequence_length)，optional) — 每个输入序列标记在位置嵌入中的位置索引。在范围[0, config.max_position_embeddings - 1]中选择。
  
• head_mask (numpy.ndarray，形状为(batch_size, sequence_length)，optional) -- 用于使注意力模块的选定头部失效的掩码。掩码值选在[0, 1]`：

• 1 表示头部未被masked，
  
• 0 表示头部被masked。
  

• return_dict (bool, optional) — 是否返回 ModelOutput 而不是普通元组。
  

返回

transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutput 或 tuple(torch.FloatTensor)

一个 transformers.modeling_flax_outputs.FlaxQuestionAnsweringModelOutput 或一个torch.FloatTensor元组（如果传递return_dict=False或config.return_dict=False）包含根据配置（XLMRobertaConfig）和输入的各种元素。

• start_logits (jnp.ndarray，形状为(batch_size, sequence_length)) — 跨度起始分数（SoftMax 之前）。
  
• end_logits (jnp.ndarray，形状为(batch_size, sequence_length)) — 跨度结束分数（SoftMax 之前）。
  
• hidden_states (tuple(jnp.ndarray), optional, 当传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的jnp.ndarray元组（一个用于嵌入的输出 + 一个用于每个层的输出）。
  模型在每个层的输出以及初始嵌入输出的隐藏状态。
  
• attentions (tuple(jnp.ndarray), optional, 当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的jnp.ndarray元组。
  在注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
  

FlaxXLMRobertaPreTrainedModel的前向方法，覆盖__call__特殊方法。

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

示例：

>>> from transformers import AutoTokenizer, FlaxXLMRobertaForQuestionAnswering
>>> tokenizer = AutoTokenizer.from_pretrained("xlm-roberta-base")
>>> model = FlaxXLMRobertaForQuestionAnswering.from_pretrained("xlm-roberta-base")
>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="jax")
>>> outputs = model(**inputs)
>>> start_scores = outputs.start_logits
>>> end_scores = outputs.end_logits