Transformers documentation
XLNet
Este modelo se publicó en HF papers el 19-06-2019 y se aportó a Hugging Face Transformers el 16-11-2020.
XLNet
Resumen
El modelo XLNet se propuso en XLNet: Generalized Autoregressive Pretraining for Language Understanding de Zhilin Yang, Zihang Dai, Yiming Yang, Jaime Carbonell, Ruslan Salakhutdinov, Quoc V. Le. XLnet es una extensión del modelo Transformer-XL preentrenado mediante un método autoregresivo para aprender contextos bidireccionales maximizando la verosimilitud esperada sobre todas las permutaciones del orden de factorización de la secuencia de entrada.
El resumen del artículo es el siguiente:
Con la capacidad de modelar contextos bidireccionales, el preentrenamiento basado en autoencoding de desruido, como BERT, logra un mejor rendimiento que los enfoques de preentrenamiento basados en modelado de lenguaje autoregresivo. Sin embargo, al depender de la corrupción de la entrada con máscaras, BERT ignora la dependencia entre las posiciones enmascaradas y sufre de una discrepancia entre el preentrenamiento y el ajuste fino. A la luz de estas ventajas y desventajas, proponemos XLNet, un método generalizado de preentrenamiento autoregresivo que (1) permite aprender contextos bidireccionales maximizando la verosimilitud esperada sobre todas las permutaciones del orden de factorización y (2) supera las limitaciones de BERT gracias a su formulación autoregresiva. Además, XLNet integra ideas de Transformer-XL, el modelo autoregresivo más avanzado, en el preentrenamiento. Empíricamente, bajo configuraciones de experimentos comparables, XLNet supera a BERT en 20 tareas, a menudo por un amplio margen, incluyendo respuesta a preguntas, inferencia de lenguaje natural, análisis de sentimiento y clasificación de documentos.
Este modelo fue aportado por thomwolf. El código original se puede encontrar aquí.
Consejos de uso
- El patrón de atención específico se puede controlar durante el entrenamiento y la prueba mediante la entrada
perm_mask. - Debido a la dificultad de entrenar un modelo completamente auto-regresivo sobre varios órdenes de factorización, XLNet se preentrena utilizando solo un subconjunto de los tokens de salida como objetivo, seleccionados mediante la entrada
target_mapping. - Para usar XLNet para decodificación secuencial (es decir, no en una configuración totalmente bidireccional), use las entradas
perm_maskytarget_mappingpara controlar el alcance de la atención y las salidas - XLNet es uno de los pocos modelos que no tiene un límite de longitud de secuencia.
- XLNet no es un modelo autorregresivo tradicional, sino que utiliza una estrategia de entrenamiento que se basa en ese concepto. Permuta los tokens de la oración y luego permite que el modelo utilice los últimos n tokens para predecir el token n+1. Dado que todo esto se realiza con una máscara, la oración se introduce en el modelo en el orden correcto, pero en lugar de enmascarar los primeros n tokens para n+1, XLNet utiliza una máscara que oculta los tokens anteriores según alguna permutación dada de 1,…,longitud de la secuencia.
- XLNet también utiliza el mismo mecanismo de recurrencia que Transformer-XL para construir dependencias a largo plazo.
Recursos
- Guía de la tarea de clasificación de texto
- Guía de la tarea de clasificación de tokens
- Guía de la tarea de respuesta a preguntas
- Guía de la tarea de modelado de lenguaje causal
- Guía de tareas de selección múltiple
XLNetConfig
clase transformers.XLNetConfig
< source >( transformers_version: str | None = Nonearchitectures: list[str] | None = Noneoutput_hidden_states: bool | None = Falsereturn_dict: bool | None = Truedtype: str | torch.dtype | None = Nonechunk_size_feed_forward: int = 0is_encoder_decoder: bool = Falseid2label: dict[int, str] | dict[str, str] | None = Nonelabel2id: dict[str, int] | dict[str, str] | None = Noneproblem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = Nonevocab_size: int = 32000d_model: int = 1024n_layer: int = 24n_head: int = 16d_inner: int = 4096d_head: int | None = Noneff_activation: str = 'gelu'attn_type: str = 'bi'initializer_range: float = 0.02layer_norm_eps: float = 1e-12dropout: float | int = 0.1mem_len: int | None = 512reuse_len: int | None = Noneuse_mems_eval: bool = Trueuse_mems_train: bool = Falsebi_data: bool = Falseclamp_len: int = -1same_length: bool = Falsesummary_type: str = 'last'summary_use_proj: bool = Truesummary_activation: str = 'tanh'summary_last_dropout: float | int = 0.1start_n_top: int = 5end_n_top: int = 5pad_token_id: int | None = 5bos_token_id: int | None = 1eos_token_id: int | list[int] | None = 2tie_word_embeddings: bool = True )
Parámetros
- vocab_size (
int, opcional, valor predeterminado32000) — Tamaño del vocabulario del modelo. Define el número de tokens diferentes que pueden representarse medianteinput_ids. - d_model (
int, opcional, valor predeterminado1024) — Tamaño de las capas del codificador y de la capa pooler. - n_layer (
int, opcional, valor predeterminado24) — Número de capas ocultas en el decodificador del Transformer. - n_head (
int, opcional, valor predeterminado16) — Número de cabezas de atención para cada capa de atención en el decodificador Transformer. - d_inner (
int, opcional, valor predeterminado4096) — Dimensión de las representaciones del MLP. - d_head (
int, opcional) — La dimensión de la cabeza de atención. Si es None, se establecerá en hidden_size // num_attention_heads - ff_activation (
stroCallable, opcional, valor predeterminado"gelu") — La función de activación no lineal (función o cadena de caracteres). Si es una cadena de caracteres, se admiten"gelu","relu","silu"y"gelu_new". - attn_type (
str, opcional, valor predeterminado"bi") — El tipo de atención utilizado por el modelo. Establece"bi"para XLNet y"uni"para Transformer-XL. - initializer_range (
float, opcional, valor predeterminado0.02) — La desviación estándar del truncated_normal_initializer para inicializar todas las matrices de pesos. - layer_norm_eps (
float, opcional, valor predeterminado1e-12) — El epsilon utilizado por las capas de normalización de capa. - dropout (
Union[float, int], opcional, valor predeterminado0.1) — La proporción para todas las capas de dropout. - mem_len (
intoNone, opcional) — El número de tokens que se deben almacenar en caché. Las parejas clave/valor que ya se hayan precalculado en una pasada anterior no se volverán a calcular. Consulte la introducción rápida para obtener más información. - reuse_len (
int, opcional) — El número de tokens del lote actual que se almacenarán en caché y se reutilizarán en el futuro. - use_mems_eval (
bool, opcional, valor predeterminadoTrue) — Indica si el modelo debe utilizar el mecanismo de memoria recurrente en modo de evaluación. - use_mems_train (
bool, opcional, valor predeterminadoFalse) — Indica si el modelo debe utilizar el mecanismo de memoria recurrente en modo de entrenamiento.Para el preentrenamiento, se recomienda establecer `use_mems_train` en `True`. Para el ajuste fino, se recomienda establecer `use_mems_train` en `False`, como se discutió [here](https://github.com/zihangdai/xlnet/issues/41#issuecomment-505102587). Si `use_mems_train` se establece en `True`, es necesario asegurarse de que los lotes de entrenamiento estén correctamente preprocesados, *p. ej.* `batch_1 = [[This line is], [This is the]]` y `batch_2 = [[ the first line], [ second line]]`, y de que todos los lotes tengan el mismo tamaño. - bi_data (
bool, opcional, valor predeterminadoFalse) — Indica si se debe utilizar o no una tubería de entrada bidireccional. Generalmente se establece enTruedurante el preentrenamiento y enFalsedurante el ajuste fino. - clamp_len (
int, opcional, valor predeterminado -1) — Limita todas las distancias relativas mayores que clamp_len. Establecer este atributo en -1 significa que no se aplica ninguna limitación. - same_length (
bool, opcional, valor predeterminadoFalse) — Indica si se debe utilizar la misma longitud de atención para cada token. - summary_type (
str, opcional, por defecto, “last”) — Argumento utilizado al realizar un resumen de secuencia. Se usa en los modelos de clasificación de secuencias y de selección múltiple. Debe ser una de las siguientes opciones:"last": Toma el estado oculto del último token (como XLNet)."first": Toma el estado oculto del primer token (como BERT)."mean": Toma la media de los estados ocultos de todos los tokens."cls_index": Proporcione un Tensor con la posición del token de clasificación (como en GPT/GPT-2)."attn": No implementado ahora, usa atención multi-cabeza.
- summary_use_proj (
bool, opcional, valor predeterminadoTrue) — Argumento utilizado al realizar un resumen de secuencia. Se usa en los modelos de clasificación de secuencias y de selección múltiple. Indica si se debe o no añadir una proyección después de la extracción del vector. - summary_activation (
str, opcional) — Argumento utilizado al realizar un resumen de secuencia. Se usa en los modelos de clasificación de secuencias y de selección múltiple. Pasa"tanh"para una activación tanh en la salida; cualquier otro valor resultará en ninguna activación. - summary_last_dropout (
float, opcional, valor predeterminado 0.1) — Se utiliza en los modelos de clasificación de secuencias y de selección múltiple. La proporción de dropout que se aplicará después de la proyección y la activación. - start_n_top (
int, opcional, valor predeterminado 5) — Se utiliza en el script de evaluación de SQuAD. - end_n_top (
int, opcional, valor predeterminado 5) — Se utiliza en el script de evaluación de SQuAD. - pad_token_id (
int, opcional, valor predeterminado5) — Id del token utilizado para el relleno en el vocabulario. - bos_token_id (
int, opcional, valor predeterminado1) — Id del token utilizado para el inicio de la secuencia en el vocabulario. - eos_token_id (
Union[int, list[int]], opcional, valor predeterminado2) — Identificador de token utilizado para el fin de secuencia en el vocabulario. - tie_word_embeddings (
bool, opcional, valor predeterminadoTrue) — Si se deben vincular las matrices de pesos de embeddings según el mapeotied_weights_keysdel modelo.
Esta es la clase de configuración para almacenar la configuración de un XLNetModel. Se utiliza para instanciar un modelo Xlnet según los argumentos especificados, definiendo la arquitectura del modelo. Instanciar una configuración con los valores predeterminados producirá una configuración similar a la de xlnet/xlnet-large-cased
Los objetos de configuración heredan de PreTrainedConfig y se pueden usar para controlar las salidas del modelo. Lea la documentación de PreTrainedConfig para obtener más información.
Ejemplos:
>>> from transformers import XLNetConfig, XLNetModel
>>> # Initializing a XLNet configuration
>>> configuration = XLNetConfig()
>>> # Initializing a model (with random weights) from the configuration
>>> model = XLNetModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configXLNetTokenizer
clase transformers.XLNetTokenizer
< source >( vocab: str | list[tuple[str, float]] | None = Noneunk_id: int = 0do_lower_case = Falseremove_space = Truekeep_accents = Falsebos_token = '<s>'eos_token = '</s>'unk_token = '<unk>'sep_token = '<sep>'pad_token = '<pad>'cls_token = '<cls>'mask_token = '<mask>'_spm_precompiled_charsmap = Noneadditional_special_tokens = None**kwargs )
Parámetros
- vocab (
list of tuples, opcional) — Lista de tuplas (token, score) para el modelo Unigram. Si no se proporciona, se utiliza una lista vacía. - unk_id (
int, opcional, valor predeterminado: 0) — El ID del token desconocido en el vocabulario. - do_lower_case (
bool, opcional, valor predeterminadoFalse) — Indica si se debe convertir la entrada en minúsculas al tokenizar. - remove_space (
bool, opcional, valor predeterminadoTrue) — Indica si se debe eliminar el texto al tokenizar (quitar espacios sobrantes antes y después de la cadena). - keep_accents (
bool, opcional, valor predeterminadoFalse) — Indica si se deben conservar las tildes al tokenizar. - bos_token (
str, opcional, por defecto"<s>") — El token de inicio de secuencia que se utilizó durante el preentrenamiento. Puede usarse como token de clasificador de secuencias. Al construir una secuencia con tokens especiales, este no es el token que se utiliza para el inicio de la secuencia. El token que se utiliza es cls_token.Al construir una secuencia con tokens especiales, este no es el token que se utiliza para el inicio de la secuencia. El token que se utiliza es
cls_token. - eos_token (
str, opcional, por defecto es"</s>") — El token de fin de secuencia. Al construir una secuencia con tokens especiales, este no es el token que se utiliza para el fin de la secuencia. El token que se utiliza es sep_token.Al construir una secuencia con tokens especiales, este no es el token que se utiliza para el final de la secuencia. El token que se utiliza es
sep_token. - unk_token (
str, opcional, valor predeterminado"<unk>") — El token desconocido. Un token que no está en el vocabulario no se puede convertir en un ID y se establece como este token en su lugar. - sep_token (
str, opcional, valor predeterminado"<sep>") — El token separador, que se utiliza al construir una secuencia a partir de varias secuencias, por ejemplo, dos secuencias para la clasificación de secuencias o un texto y una pregunta para la respuesta a preguntas. También se utiliza como el último token de una secuencia construida con tokens especiales. - pad_token (
str, opcional, valor predeterminado"<pad>") — El token utilizado para el relleno, por ejemplo, al agrupar secuencias de diferentes longitudes. - cls_token (
str, opcional, valor predeterminado"<cls>") — El token clasificador que se utiliza al realizar clasificación de secuencias (clasificación de la secuencia completa en lugar de clasificación por token). Es el primer token de la secuencia cuando se construye con tokens especiales. - mask_token (
str, opcional, valor predeterminado"<mask>") — El token utilizado para enmascarar valores. Este es el token que se emplea al entrenar este modelo con modelado de lenguaje enmascarado. Es el token que el modelo intentará predecir. - additional_special_tokens (
list[str], opcional, valor predeterminado["<eop>", "<eod>"]) — Tokens especiales adicionales utilizados por el tokenizador.
Construye un tokenizador de XLNet (respaldado por la biblioteca tokenizers de HuggingFace). Basado en Unigram.
Este tokenizador hereda de TokenizersBackend, que contiene la mayoría de los métodos principales. Los usuarios deben consultar esta superclase para obtener más información sobre dichos métodos.
get_special_tokens_mask
< source >( token_ids_0: list[int]token_ids_1: list[int] | None = Nonealready_has_special_tokens: bool = False ) → A list of integers in the range [0, 1]
Parámetros
- token_ids_0 — Lista de IDs de la secuencia (posiblemente ya formateada).
- token_ids_1 — No se usa cuando
already_has_special_tokens=True. Debe ser None en ese caso. - already_has_special_tokens — Indica si la secuencia ya está formateada con tokens especiales.
Devuelve
Una lista de enteros en el rango [0, 1]
1 para un token especial, 0 para un token de secuencia.
Obtener los ids de secuencia de una lista de tokens a la que no se le han añadido tokens especiales.
Para los tokenizadores rápidos, los collators de datos llaman a esto con already_has_special_tokens=True para construir una máscara sobre una secuencia ya formateada. En ese caso, calculamos la máscara comprobando la pertenencia en all_special_ids.
Salidas específicas de XLNet
clase transformers.models.xlnet.modeling_xlnet.XLNetModelOutput
< source >( last_hidden_state: Tensormems: list[torch.Tensor] | None = Nonehidden_states: tuple[torch.Tensor, ...] | None = Noneattentions: tuple[torch.Tensor, ...] | None = None )
Parámetros
- last_hidden_state (
torch.Tensorde forma(batch_size, num_predict, hidden_size)) — Secuencia de estados ocultos en la última capa del modelo.num_predictcorresponde atarget_mapping.shape[1]. Sitarget_mappingesNone, entoncesnum_predictcorresponde asequence_length. - mems (
list[torch.Tensor]de longitudconfig.n_layers) — Contiene hidden-states precalculados. Se puede usar (ver entradamems) para acelerar la decodificación secuencial. Los ids de tokens cuyo pasado se ha proporcionado a este modelo no deben pasarse comoinput_idsya que ya han sido calculados. - hidden_states (
tuple[torch.Tensor, ...], opcional, se devuelve cuandooutput_hidden_states=Truese pasa o cuandoconfig.output_hidden_states=True) — Tupla detorch.Tensor(uno para la salida de los embeddings, si el modelo tiene una capa de embedding, + uno para la salida de cada capa) de forma(batch_size, sequence_length, hidden_size).Estados ocultos del modelo en la salida de cada capa más las salidas opcionales de la incrustación inicial.
- attentions (
tuple[torch.Tensor, ...], opcional, se devuelve cuandooutput_attentions=Truese pasa o cuandoconfig.output_attentions=True) — Tupla detorch.Tensor(uno por cada capa) de forma(batch_size, num_heads, sequence_length, sequence_length).Pesos de atención tras el softmax de atención, utilizados para calcular la media ponderada en las cabezas de autoatención.
Tipo de salida de XLNetModel.
clase transformers.models.xlnet.modeling_xlnet.XLNetLMHeadModelOutput
< source >( loss: typing.Optional[torch.Tensor] = Nonelogits: typing.Optional[torch.Tensor] = Nonemems: list[torch.Tensor] | None = Nonehidden_states: tuple[torch.Tensor, ...] | None = Noneattentions: tuple[torch.Tensor, ...] | None = None )
Parámetros
- loss (
torch.Tensorde forma (1,), opcional, se devuelve cuando se proporcionalabels) — Pérdida de modelado de lenguaje (para la predicción del siguiente token). - logits (
torch.Tensorde forma(batch_size, num_predict, config.vocab_size)) — Puntuaciones de predicción de la cabeza de modelado de lenguaje (puntuaciones para cada token del vocabulario antes de SoftMax).num_predictcorresponde atarget_mapping.shape[1]. Sitarget_mappingesNone, entoncesnum_predictcorresponde asequence_length. - mems (
list[torch.Tensor]de longitudconfig.n_layers) — Contiene hidden-states precalculados. Se puede usar (ver entradamems) para acelerar la decodificación secuencial. Los ids de tokens cuyo pasado se ha proporcionado a este modelo no deben pasarse comoinput_idsya que ya han sido calculados. - hidden_states (
tuple[torch.Tensor, ...], opcional, se devuelve cuandooutput_hidden_states=Truese pasa o cuandoconfig.output_hidden_states=True) — Tupla detorch.Tensor(uno para la salida de los embeddings, si el modelo tiene una capa de embedding, + uno para la salida de cada capa) de forma(batch_size, sequence_length, hidden_size).Estados ocultos del modelo en la salida de cada capa más las salidas opcionales de la incrustación inicial.
- attentions (
tuple[torch.Tensor, ...], opcional, se devuelve cuandooutput_attentions=Truese pasa o cuandoconfig.output_attentions=True) — Tupla detorch.Tensor(uno por cada capa) de forma(batch_size, num_heads, sequence_length, sequence_length).Pesos de atención tras el softmax de atención, utilizados para calcular la media ponderada en las cabezas de autoatención.
Tipo de salida de XLNetLMHeadModel.
clase transformers.models.xlnet.modeling_xlnet.XLNetForSequenceClassificationOutput
< source >( loss: typing.Optional[torch.Tensor] = Nonelogits: typing.Optional[torch.Tensor] = Nonemems: list[torch.Tensor] | None = Nonehidden_states: tuple[torch.Tensor, ...] | None = Noneattentions: tuple[torch.Tensor, ...] | None = None )
Parámetros
- loss (
torch.Tensorde forma(1,), opcional, se devuelve cuando se proporcionalabel) — Pérdida de clasificación (o de regresión si config.num_labels==1). - logits (
torch.Tensorde forma(batch_size, config.num_labels)) — Puntuaciones de clasificación (o de regresión si config.num_labels==1) (antes de SoftMax). - mems (
list[torch.Tensor]de longitudconfig.n_layers) — Contiene hidden-states precalculados. Se puede usar (ver entradamems) para acelerar la decodificación secuencial. Los ids de tokens cuyo pasado se ha proporcionado a este modelo no deben pasarse comoinput_idsya que ya han sido calculados. - hidden_states (
tuple[torch.Tensor, ...], opcional, se devuelve cuandooutput_hidden_states=Truese pasa o cuandoconfig.output_hidden_states=True) — Tupla detorch.Tensor(uno para la salida de los embeddings, si el modelo tiene una capa de embedding, + uno para la salida de cada capa) de forma(batch_size, sequence_length, hidden_size).Estados ocultos del modelo en la salida de cada capa más las salidas opcionales de la incrustación inicial.
- attentions (
tuple[torch.Tensor, ...], opcional, se devuelve cuandooutput_attentions=Truese pasa o cuandoconfig.output_attentions=True) — Tupla detorch.Tensor(uno por cada capa) de forma(batch_size, num_heads, sequence_length, sequence_length).Pesos de atención tras el softmax de atención, utilizados para calcular la media ponderada en las cabezas de autoatención.
Tipo de salida de XLNetForSequenceClassification.
clase transformers.models.xlnet.modeling_xlnet.XLNetForMultipleChoiceOutput
< source >( loss: typing.Optional[torch.Tensor] = Nonelogits: typing.Optional[torch.Tensor] = Nonemems: list[torch.Tensor] | None = Nonehidden_states: tuple[torch.Tensor, ...] | None = Noneattentions: tuple[torch.Tensor, ...] | None = None )
Parámetros
- loss (
torch.Tensorde forma (1,), opcional, se devuelve cuando se proporcionalabels) — Pérdida de clasificación. - logits (
torch.Tensorde forma(batch_size, num_choices)) — num_choices es la segunda dimensión de los tensores de entrada. (ver input_ids anteriormente).Puntuaciones de clasificación (antes de SoftMax).
- mems (
list[torch.Tensor]de longitudconfig.n_layers) — Contiene hidden-states precalculados. Se puede usar (ver entradamems) para acelerar la decodificación secuencial. Los ids de tokens cuyo pasado se ha proporcionado a este modelo no deben pasarse comoinput_idsya que ya han sido calculados. - hidden_states (
tuple[torch.Tensor, ...], opcional, se devuelve cuandooutput_hidden_states=Truese pasa o cuandoconfig.output_hidden_states=True) — Tupla detorch.Tensor(uno para la salida de los embeddings, si el modelo tiene una capa de embedding, + uno para la salida de cada capa) de forma(batch_size, sequence_length, hidden_size).Estados ocultos del modelo en la salida de cada capa más las salidas opcionales de la incrustación inicial.
- attentions (
tuple[torch.Tensor, ...], opcional, se devuelve cuandooutput_attentions=Truese pasa o cuandoconfig.output_attentions=True) — Tupla detorch.Tensor(uno por cada capa) de forma(batch_size, num_heads, sequence_length, sequence_length).Pesos de atención tras el softmax de atención, utilizados para calcular la media ponderada en las cabezas de autoatención.
Tipo de salida de XLNetForMultipleChoice.
clase transformers.models.xlnet.modeling_xlnet.XLNetForTokenClassificationOutput
< source >( loss: typing.Optional[torch.Tensor] = Nonelogits: typing.Optional[torch.Tensor] = Nonemems: list[torch.Tensor] | None = Nonehidden_states: tuple[torch.Tensor, ...] | None = Noneattentions: tuple[torch.Tensor, ...] | None = None )
Parámetros
- loss (
torch.Tensorde forma(1,), opcional, se devuelve cuando se proporcionalabels) — Pérdida de clasificación. - logits (
torch.Tensorde forma(batch_size, sequence_length, config.num_labels)) — Puntuaciones de clasificación (antes de SoftMax). - mems (
list[torch.Tensor]de longitudconfig.n_layers) — Contiene hidden-states precalculados. Se puede usar (ver entradamems) para acelerar la decodificación secuencial. Los ids de tokens cuyo pasado se ha proporcionado a este modelo no deben pasarse comoinput_idsya que ya han sido calculados. - hidden_states (
tuple[torch.Tensor, ...], opcional, se devuelve cuandooutput_hidden_states=Truese pasa o cuandoconfig.output_hidden_states=True) — Tupla detorch.Tensor(uno para la salida de los embeddings, si el modelo tiene una capa de embedding, + uno para la salida de cada capa) de forma(batch_size, sequence_length, hidden_size).Estados ocultos del modelo en la salida de cada capa más las salidas opcionales de la incrustación inicial.
- attentions (
tuple[torch.Tensor, ...], opcional, se devuelve cuandooutput_attentions=Truese pasa o cuandoconfig.output_attentions=True) — Tupla detorch.Tensor(uno por cada capa) de forma(batch_size, num_heads, sequence_length, sequence_length).Pesos de atención tras el softmax de atención, utilizados para calcular la media ponderada en las cabezas de autoatención.
Tipo de salida de XLNetForTokenClassificationOutput.
clase transformers.models.xlnet.modeling_xlnet.XLNetForQuestionAnsweringSimpleOutput
< source >( loss: typing.Optional[torch.Tensor] = Nonestart_logits: typing.Optional[torch.Tensor] = Noneend_logits: typing.Optional[torch.Tensor] = Nonemems: list[torch.Tensor] | None = Nonehidden_states: tuple[torch.Tensor, ...] | None = Noneattentions: tuple[torch.Tensor, ...] | None = None )
Parámetros
- loss (
torch.Tensorde forma(1,), opcional, se devuelve cuando se proporcionalabels) — La pérdida total de extracción de tramos es la suma de una Entropía Cruzada para las posiciones de inicio y fin. - start_logits (
torch.Tensorde forma(batch_size, sequence_length,)) — Puntuaciones de inicio de tramo (antes de SoftMax). - end_logits (
torch.Tensorde forma(batch_size, sequence_length,)) — Puntuaciones de fin de tramo (antes de SoftMax). - mems (
list[torch.Tensor]de longitudconfig.n_layers) — Contiene hidden-states precalculados. Se puede usar (ver entradamems) para acelerar la decodificación secuencial. Los ids de tokens cuyo pasado se ha proporcionado a este modelo no deben pasarse comoinput_idsya que ya han sido calculados. - hidden_states (
tuple[torch.Tensor, ...], opcional, se devuelve cuandooutput_hidden_states=Truese pasa o cuandoconfig.output_hidden_states=True) — Tupla detorch.Tensor(uno para la salida de los embeddings, si el modelo tiene una capa de embedding, + uno para la salida de cada capa) de forma(batch_size, sequence_length, hidden_size).Estados ocultos del modelo en la salida de cada capa más las salidas opcionales de la incrustación inicial.
- attentions (
tuple[torch.Tensor, ...], opcional, se devuelve cuandooutput_attentions=Truese pasa o cuandoconfig.output_attentions=True) — Tupla detorch.Tensor(uno por cada capa) de forma(batch_size, num_heads, sequence_length, sequence_length).Pesos de atención tras el softmax de atención, utilizados para calcular la media ponderada en las cabezas de autoatención.
Tipo de salida de XLNetForQuestionAnsweringSimple.
clase transformers.models.xlnet.modeling_xlnet.XLNetForQuestionAnsweringOutput
< source >( loss: typing.Optional[torch.Tensor] = Nonestart_top_log_probs: typing.Optional[torch.Tensor] = Nonestart_top_index: typing.Optional[torch.LongTensor] = Noneend_top_log_probs: typing.Optional[torch.Tensor] = Noneend_top_index: typing.Optional[torch.LongTensor] = Nonecls_logits: typing.Optional[torch.Tensor] = Nonemems: list[torch.Tensor] | None = Nonehidden_states: tuple[torch.Tensor, ...] | None = Noneattentions: tuple[torch.Tensor, ...] | None = None )
Parámetros
- loss (
torch.Tensorde forma(1,), opcional, se devuelve si se proporcionan tantostart_positionscomoend_positions) — Pérdida de clasificación como la suma de las pérdidas de clasificación del token de inicio, del token de finalización (y de is_impossible si se proporciona). - start_top_log_probs (
torch.Tensorde forma(batch_size, config.start_n_top), opcional, se devuelve si no se proporcionastart_positionsoend_positions) — Probabilidades logarítmicas para las config.start_n_top posibilidades de tokens de inicio (beam-search). - start_top_index (
torch.LongTensorde forma(batch_size, config.start_n_top), opcional, se devuelve si no se proporcionastart_positionsoend_positions) — Índices de las config.start_n_top mejores posibilidades de tokens de inicio (búsqueda por haz). - end_top_log_probs (
torch.Tensorde forma(batch_size, config.start_n_top * config.end_n_top), opcional, se devuelve si no se proporcionastart_positionsoend_positions) — Probabilidades logarítmicas para lasconfig.start_n_top * config.end_n_topposibilidades de tokens finales más probables (beam-search). - end_top_index (
torch.LongTensorde forma(batch_size, config.start_n_top * config.end_n_top), opcional, se devuelve si no se proporcionastart_positionsoend_positions) — Índices para lasconfig.start_n_top * config.end_n_topposibilidades de tokens finales (beam-search). - cls_logits (
torch.Tensorde forma(batch_size,), opcional, se devuelve si no se proporcionastart_positionsoend_positions) — Probabilidades logarítmicas para la etiquetais_impossiblede las respuestas. - mems (
list[torch.Tensor]de longitudconfig.n_layers) — Contiene hidden-states precalculados. Se puede usar (ver entradamems) para acelerar la decodificación secuencial. Los ids de tokens cuyo pasado se ha proporcionado a este modelo no deben pasarse comoinput_idsya que ya han sido calculados. - hidden_states (
tuple[torch.Tensor, ...], opcional, se devuelve cuandooutput_hidden_states=Truese pasa o cuandoconfig.output_hidden_states=True) — Tupla detorch.Tensor(uno para la salida de los embeddings, si el modelo tiene una capa de embedding, + uno para la salida de cada capa) de forma(batch_size, sequence_length, hidden_size).Estados ocultos del modelo en la salida de cada capa más las salidas opcionales de la incrustación inicial.
- attentions (
tuple[torch.Tensor, ...], opcional, se devuelve cuandooutput_attentions=Truese pasa o cuandoconfig.output_attentions=True) — Tupla detorch.Tensor(uno por cada capa) de forma(batch_size, num_heads, sequence_length, sequence_length).Pesos de atención tras el softmax de atención, utilizados para calcular la media ponderada en las cabezas de autoatención.
Tipo de salida de XLNetForQuestionAnswering.
XLNetModel
clase transformers.XLNetModel
< source >( config: XLNetConfig )
Parámetros
- config (XLNetConfig) — Clase de configuración del modelo con todos los parámetros del modelo. Inicializar con un archivo de configuración no carga los pesos asociados con el modelo, solo la configuración. Consulte el método from_pretrained() para cargar los pesos del modelo.
El modelo Xlnet básico que genera estados ocultos sin ningún cabezal específico en la parte superior.
Este modelo hereda de PreTrainedModel. Consulta la documentación de la clase superior para los métodos genéricos que la biblioteca implementa para todos sus modelos (como la descarga o el guardado, el redimensionamiento de las incrustaciones de entrada, la poda de cabezas, etc.).
Este modelo también es una subclase de torch.nn.Module de PyTorch. Úsalo como un módulo de PyTorch regular y consulta la documentación de PyTorch para todo lo relacionado con el uso y el comportamiento generales.
forward
< source >( input_ids: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonemems: typing.Optional[torch.Tensor] = Noneperm_mask: typing.Optional[torch.Tensor] = Nonetarget_mapping: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneinput_mask: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Noneuse_mems: bool | None = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → XLNetModelOutput or tuple(torch.Tensor)
Parámetros
- input_ids (
torch.Tensorde forma(batch_size, sequence_length), opcional) — Índices de los tokens de la secuencia de entrada en el vocabulario. El relleno se ignorará de forma predeterminada.Los índices se pueden obtener usando AutoTokenizer. Consulte PreTrainedTokenizer.encode() y PreTrainedTokenizer.call() para más detalles.
- attention_mask (
torch.Tensorde forma(batch_size, sequence_length), opcional) — Máscara para evitar realizar atención en los índices de tokens de relleno. Valores de máscara seleccionados en[0, 1]:- 1 para los tokens que no están enmascarados,
- 0 para los tokens que están enmascarados.
- mems (
list[torch.Tensor]de longitudconfig.n_layers) — Contiene estados ocultos precalculados (véase la salidamemsa continuación). Se puede usar para acelerar la decodificación secuencial. Los ids de tokens cuyo pasado se ha proporcionado a este modelo no deben pasarse comoinput_idsya que ya se han calculado.use_memsdebe establecerse enTruepara hacer uso demems. - perm_mask (
torch.Tensorde forma(batch_size, sequence_length, sequence_length), opcional) — Máscara para indicar el patrón de atención de cada token de entrada con valores seleccionados en[0, 1]:- si
perm_mask[k, i, j] = 0, i atiende a j en el lote k; - Si
perm_mask[k, i, j] = 1, i no atiende a j en el lote k.
Si no se establece, cada token atiende a todos los demás (atención bidireccional completa). Solo se utiliza durante el preentrenamiento (para definir el orden de factorización) o para la decodificación secuencial (generación).
- si
- target_mapping (
torch.Tensorde forma(batch_size, num_predict, sequence_length), opcional) — Máscara para indicar los tokens de salida a utilizar. Sitarget_mapping[k, i, j] = 1, la i-ésima predicción del lote k está en el j-ésimo token. Solo se utiliza durante el preentrenamiento para la predicción parcial o para la decodificación secuencial (generación). - token_type_ids (
torch.Tensorde forma(batch_size, sequence_length), opcional) — Índices de tokens de segmento para indicar las primeras y segundas partes de las entradas. Los índices se seleccionan en[0, 1]:- 0 corresponde a un token de sentence A,
- 1 corresponde a un token de sentence B.
- input_mask (
torch.Tensorde formabatch_size, sequence_length, opcional) — Máscara para evitar realizar atención en los índices de tokens de relleno. Negativo deattention_mask, es decir, con 0 para tokens reales y 1 para relleno, lo cual se mantiene por compatibilidad con la base de código original.Valores de máscara seleccionados en
[0, 1]:- 1 para los tokens que están mascarados,
- 0 para los tokens que no están enmascarados.
Solo puede usar uno de
input_maskyattention_mask. - inputs_embeds (
torch.Tensorde forma(batch_size, sequence_length, hidden_size), opcional) — Opcionalmente, en lugar de pasarinput_ids, puedes elegir pasar directamente una representación incrustada. Esto es útil si deseas tener más control sobre cómo convertir los índices deinput_idsen los vectores asociados que en la matriz de búsqueda de incrustaciones interna del modelo. - use_mems (
bool, opcional) — Indica si se deben usar estados de memoria para acelerar la decodificación secuencial. Si se establece enTrue, el modelo utilizará los estados ocultos de las pasadas anteriores para calcular la atención, lo que puede mejorar significativamente el rendimiento en tareas de decodificación secuencial. - output_attentions (
bool, opcional) — Indica si se deben devolver los tensores de atención de todas las capas de atención. Consulteattentionsen los tensores devueltos para obtener más detalles. - output_hidden_states (
bool, opcional) — Indica si se deben devolver los estados ocultos de todas las capas. Consultehidden_statesen los tensores devueltos para obtener más detalles. - return_dict (
bool, opcional) — Indica si se debe devolver un ModelOutput en lugar de una tupla simple.
Devuelve
XLNetModelOutput o tuple(torch.Tensor)
Un XLNetModelOutput o una tupla de
torch.Tensor (si se pasa return_dict=False o cuando config.return_dict=False) que comprende varios
elementos según la configuración (XLNetConfig) y las entradas.
El método forward de XLNetModel sobrescribe el método especial __call__.
Aunque la receta para la pasada hacia adelante debe definirse dentro de esta función, se debe llamar a la instancia de
Moduledespués en lugar de a esta, ya que la primera se encarga de ejecutar los pasos de pre y postprocesamiento, mientras que la segunda los ignora silenciosamente.
last_hidden_state (
torch.Tensorde forma(batch_size, num_predict, hidden_size)) — Secuencia de estados ocultos en la última capa del modelo.num_predictcorresponde atarget_mapping.shape[1]. Sitarget_mappingesNone, entoncesnum_predictcorresponde asequence_length.mems (
list[torch.Tensor]de longitudconfig.n_layers) — Contiene hidden-states precalculados. Se puede utilizar (ver entradamems) para acelerar la decodificación secuencial. Los ids de tokens cuyo pasado se ha proporcionado a este modelo no deben pasarse comoinput_idsya que ya han sido calculados.hidden_states (
tuple[torch.Tensor, ...], opcional, se devuelve cuando se pasaoutput_hidden_states=Trueo cuandoconfig.output_hidden_states=True) — Tupla detorch.Tensor(una para la salida de las incrustaciones, si el modelo tiene una capa de incrustaciones, + una para la salida de cada capa) de forma(batch_size, sequence_length, hidden_size).Estados ocultos del modelo en la salida de cada capa más las salidas opcionales de la incrustación inicial.
attentions (
tuple[torch.Tensor, ...], opcional, se devuelve cuando se pasaoutput_attentions=Trueo cuandoconfig.output_attentions=True) — Tupla detorch.Tensor(una por cada capa) de forma(batch_size, num_heads, sequence_length, sequence_length).Pesos de atención tras el softmax de atención, utilizados para calcular la media ponderada en las cabezas de autoatención.
XLNetLMHeadModel
clase transformers.XLNetLMHeadModel
< source >( config: XLNetConfig )
Parámetros
- config (XLNetConfig) — Clase de configuración del modelo con todos los parámetros del modelo. Inicializar con un archivo de configuración no carga los pesos asociados con el modelo, solo la configuración. Consulte el método from_pretrained() para cargar los pesos del modelo.
Modelo XLNet con una cabeza de modelado de lenguaje en la parte superior (capa lineal con pesos vinculados a las incrustaciones de entrada).
Este modelo hereda de PreTrainedModel. Consulta la documentación de la clase superior para los métodos genéricos que la biblioteca implementa para todos sus modelos (como la descarga o el guardado, el redimensionamiento de las incrustaciones de entrada, la poda de cabezas, etc.).
Este modelo también es una subclase de torch.nn.Module de PyTorch. Úsalo como un módulo de PyTorch regular y consulta la documentación de PyTorch para todo lo relacionado con el uso y el comportamiento generales.
forward
< source >( input_ids: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonemems: typing.Optional[torch.Tensor] = Noneperm_mask: typing.Optional[torch.Tensor] = Nonetarget_mapping: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneinput_mask: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.Tensor] = Noneuse_mems: bool | None = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = Nonelogits_to_keep: typing.Union[int, torch.Tensor] = 0**kwargs ) → XLNetLMHeadModelOutput or tuple(torch.Tensor)
Parámetros
- input_ids (
torch.Tensorde forma(batch_size, sequence_length), opcional) — Índices de los tokens de la secuencia de entrada en el vocabulario. El relleno se ignorará de forma predeterminada.Los índices se pueden obtener usando AutoTokenizer. Consulte PreTrainedTokenizer.encode() y PreTrainedTokenizer.call() para más detalles.
- attention_mask (
torch.Tensorde forma(batch_size, sequence_length), opcional) — Máscara para evitar realizar atención en los índices de tokens de relleno. Valores de máscara seleccionados en[0, 1]:- 1 para los tokens que no están enmascarados,
- 0 para los tokens que están enmascarados.
- mems (
list[torch.Tensor]de longitudconfig.n_layers) — Contiene estados ocultos precalculados (véase la salidamemsa continuación). Se puede usar para acelerar la decodificación secuencial. Los ids de tokens cuyo pasado se ha proporcionado a este modelo no deben pasarse comoinput_idsya que ya se han calculado.use_memsdebe establecerse enTruepara hacer uso demems. - perm_mask (
torch.Tensorde forma(batch_size, sequence_length, sequence_length), opcional) — Máscara para indicar el patrón de atención de cada token de entrada con valores seleccionados en[0, 1]:- si
perm_mask[k, i, j] = 0, i atiende a j en el lote k; - Si
perm_mask[k, i, j] = 1, i no atiende a j en el lote k.
Si no se establece, cada token atiende a todos los demás (atención bidireccional completa). Solo se utiliza durante el preentrenamiento (para definir el orden de factorización) o para la decodificación secuencial (generación).
- si
- target_mapping (
torch.Tensorde forma(batch_size, num_predict, sequence_length), opcional) — Máscara para indicar los tokens de salida a utilizar. Sitarget_mapping[k, i, j] = 1, la i-ésima predicción del lote k está en el j-ésimo token. Solo se utiliza durante el preentrenamiento para la predicción parcial o para la decodificación secuencial (generación). - token_type_ids (
torch.Tensorde forma(batch_size, sequence_length), opcional) — Índices de tokens de segmento para indicar las primeras y segundas partes de las entradas. Los índices se seleccionan en[0, 1]:- 0 corresponde a un token de sentence A,
- 1 corresponde a un token de sentence B.
- input_mask (
torch.Tensorde formabatch_size, sequence_length, opcional) — Máscara para evitar realizar atención en los índices de tokens de relleno. Negativo deattention_mask, es decir, con 0 para tokens reales y 1 para relleno, lo cual se mantiene por compatibilidad con la base de código original.Valores de máscara seleccionados en
[0, 1]:- 1 para los tokens que están mascarados,
- 0 para los tokens que no están enmascarados.
Solo puede usar uno de
input_maskyattention_mask. - inputs_embeds (
torch.Tensorde forma(batch_size, sequence_length, hidden_size), opcional) — Opcionalmente, en lugar de pasarinput_ids, puedes elegir pasar directamente una representación incrustada. Esto es útil si deseas tener más control sobre cómo convertir los índices deinput_idsen los vectores asociados que en la matriz de búsqueda de incrustaciones interna del modelo. - labels (
torch.LongTensorde forma(batch_size, num_predict), opcional) — Etiquetas para el modelado de lenguaje enmascarado.num_predictcorresponde atarget_mapping.shape[1]. Sitarget_mappingesNone, entoncesnum_predictcorresponde asequence_length.Las etiquetas deben corresponder a las palabras de entrada enmascaradas que se deben predecir y dependen de
target_mapping. Tenga en cuenta que, para realizar un modelado de lenguaje auto-regresivo estándar, se debe añadir un tokena input_ids(consulte la funciónprepare_inputs_for_generationy los ejemplos a continuación)Los índices se seleccionan en
[-100, 0, ..., config.vocab_size]Todas las etiquetas fijadas en-100se ignoran; la pérdida solo se calcula para las etiquetas en[0, ..., config.vocab_size] - use_mems (
bool, opcional) — Indica si se deben usar estados de memoria para acelerar la decodificación secuencial. Si se establece enTrue, el modelo utilizará los estados ocultos de las pasadas anteriores para calcular la atención, lo que puede mejorar significativamente el rendimiento en tareas de decodificación secuencial. - output_attentions (
bool, opcional) — Indica si se deben devolver los tensores de atención de todas las capas de atención. Consulteattentionsen los tensores devueltos para obtener más detalles. - output_hidden_states (
bool, opcional) — Indica si se deben devolver los estados ocultos de todas las capas. Consultehidden_statesen los tensores devueltos para obtener más detalles. - return_dict (
bool, opcional) — Indica si se debe devolver un ModelOutput en lugar de una tupla simple. - logits_to_keep (
Union[int, torch.Tensor], opcional, valor predeterminado0) — Si es unint, calcula los logits para los últimoslogits_to_keeptokens. Si es0, calcula los logits para todos losinput_ids(caso especial). Solo se necesitan los logits del último token para la generación, y calcularlos solo para ese token puede ahorrar memoria, lo cual se vuelve bastante significativo para secuencias largas o un tamaño de vocabulario grande. Si es untorch.Tensor, debe ser de 1D y corresponder a los índices a conservar en la dimensión de longitud de secuencia. Esto es útil al usar el formato de tensor empaquetado (una sola dimensión para el lote y la longitud de secuencia).
Devuelve
XLNetLMHeadModelOutput o tuple(torch.Tensor)
Un XLNetLMHeadModelOutput o una tupla de
torch.Tensor (si se pasa return_dict=False o cuando config.return_dict=False) que comprende varios
elementos según la configuración (XLNetConfig) y las entradas.
El método forward de XLNetLMHeadModel reemplaza el método especial __call__.
Aunque la receta para la pasada hacia adelante debe definirse dentro de esta función, se debe llamar a la instancia de
Moduledespués en lugar de a esta, ya que la primera se encarga de ejecutar los pasos de pre y postprocesamiento, mientras que la segunda los ignora silenciosamente.
loss (
torch.Tensorde forma (1,), opcional, se devuelve cuando se proporcionalabels) — Pérdida de modelado de lenguaje (para la predicción del siguiente token).logits (
torch.Tensorde forma(batch_size, num_predict, config.vocab_size)) — Puntuaciones de predicción de la cabeza de modelado de lenguaje (puntuaciones para cada token del vocabulario antes de SoftMax).num_predictcorresponde atarget_mapping.shape[1]. Sitarget_mappingesNone, entoncesnum_predictcorresponde asequence_length.mems (
list[torch.Tensor]de longitudconfig.n_layers) — Contiene hidden-states precalculados. Se puede utilizar (ver entradamems) para acelerar la decodificación secuencial. Los ids de tokens cuyo pasado se ha proporcionado a este modelo no deben pasarse comoinput_idsya que ya han sido calculados.hidden_states (
tuple[torch.Tensor, ...], opcional, se devuelve cuando se pasaoutput_hidden_states=Trueo cuandoconfig.output_hidden_states=True) — Tupla detorch.Tensor(una para la salida de las incrustaciones, si el modelo tiene una capa de incrustaciones, + una para la salida de cada capa) de forma(batch_size, sequence_length, hidden_size).Estados ocultos del modelo en la salida de cada capa más las salidas opcionales de la incrustación inicial.
attentions (
tuple[torch.Tensor, ...], opcional, se devuelve cuando se pasaoutput_attentions=Trueo cuandoconfig.output_attentions=True) — Tupla detorch.Tensor(una por cada capa) de forma(batch_size, num_heads, sequence_length, sequence_length).Pesos de atención tras el softmax de atención, utilizados para calcular la media ponderada en las cabezas de autoatención.
Ejemplos:
>>> from transformers import AutoTokenizer, XLNetLMHeadModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("xlnet/xlnet-large-cased")
>>> model = XLNetLMHeadModel.from_pretrained("xlnet/xlnet-large-cased")
>>> # We show how to setup inputs to predict a next token using a bi-directional context.
>>> input_ids = torch.tensor(
... tokenizer.encode("Hello, my dog is very <mask>", add_special_tokens=False)
... ).unsqueeze(
... 0
... ) # We will predict the masked token
>>> perm_mask = torch.zeros((1, input_ids.shape[1], input_ids.shape[1]), dtype=torch.float)
>>> perm_mask[:, :, -1] = 1.0 # Previous tokens don't see last token
>>> target_mapping = torch.zeros(
... (1, 1, input_ids.shape[1]), dtype=torch.float
... ) # Shape [1, 1, seq_length] => let's predict one token
>>> target_mapping[
... 0, 0, -1
... ] = 1.0 # Our first (and only) prediction will be the last token of the sequence (the masked token)
>>> outputs = model(input_ids, perm_mask=perm_mask, target_mapping=target_mapping)
>>> next_token_logits = outputs[
... 0
... ] # Output has shape [target_mapping.size(0), target_mapping.size(1), config.vocab_size]
>>> # The same way can the XLNetLMHeadModel be used to be trained by standard auto-regressive language modeling.
>>> input_ids = torch.tensor(
... tokenizer.encode("Hello, my dog is very <mask>", add_special_tokens=False)
... ).unsqueeze(
... 0
... ) # We will predict the masked token
>>> labels = torch.tensor(tokenizer.encode("cute", add_special_tokens=False)).unsqueeze(0)
>>> assert labels.shape[0] == 1, "only one word will be predicted"
>>> perm_mask = torch.zeros((1, input_ids.shape[1], input_ids.shape[1]), dtype=torch.float)
>>> perm_mask[
... :, :, -1
... ] = 1.0 # Previous tokens don't see last token as is done in standard auto-regressive lm training
>>> target_mapping = torch.zeros(
... (1, 1, input_ids.shape[1]), dtype=torch.float
... ) # Shape [1, 1, seq_length] => let's predict one token
>>> target_mapping[
... 0, 0, -1
... ] = 1.0 # Our first (and only) prediction will be the last token of the sequence (the masked token)
>>> outputs = model(input_ids, perm_mask=perm_mask, target_mapping=target_mapping, labels=labels)
>>> loss = outputs.loss
>>> next_token_logits = (
... outputs.logits
... ) # Logits have shape [target_mapping.size(0), target_mapping.size(1), config.vocab_size]XLNetForSequenceClassification
clase transformers.XLNetForSequenceClassification
< source >( config: XLNetConfig )
Parámetros
- config (XLNetConfig) — Clase de configuración del modelo con todos los parámetros del modelo. Inicializar con un archivo de configuración no carga los pesos asociados con el modelo, solo la configuración. Consulte el método from_pretrained() para cargar los pesos del modelo.
Modelo XLNet con una cabeza de clasificación/regresión de secuencias en la parte superior (una capa lineal sobre la salida agrupada), por ejemplo, para tareas GLUE.
Este modelo hereda de PreTrainedModel. Consulta la documentación de la clase superior para los métodos genéricos que la biblioteca implementa para todos sus modelos (como la descarga o el guardado, el redimensionamiento de las incrustaciones de entrada, la poda de cabezas, etc.).
Este modelo también es una subclase de torch.nn.Module de PyTorch. Úsalo como un módulo de PyTorch regular y consulta la documentación de PyTorch para todo lo relacionado con el uso y el comportamiento generales.
forward
< source >( input_ids: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonemems: typing.Optional[torch.Tensor] = Noneperm_mask: typing.Optional[torch.Tensor] = Nonetarget_mapping: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneinput_mask: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.Tensor] = Noneuse_mems: bool | None = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → XLNetForSequenceClassificationOutput or tuple(torch.Tensor)
Parámetros
- input_ids (
torch.Tensorde forma(batch_size, sequence_length), opcional) — Índices de los tokens de la secuencia de entrada en el vocabulario. El relleno se ignorará de forma predeterminada.Los índices se pueden obtener usando AutoTokenizer. Consulte PreTrainedTokenizer.encode() y PreTrainedTokenizer.call() para más detalles.
- attention_mask (
torch.Tensorde forma(batch_size, sequence_length), opcional) — Máscara para evitar realizar atención en los índices de tokens de relleno. Valores de máscara seleccionados en[0, 1]:- 1 para los tokens que no están enmascarados,
- 0 para los tokens que están enmascarados.
- mems (
list[torch.Tensor]de longitudconfig.n_layers) — Contiene estados ocultos precalculados (véase la salidamemsa continuación). Se puede usar para acelerar la decodificación secuencial. Los ids de tokens cuyo pasado se ha proporcionado a este modelo no deben pasarse comoinput_idsya que ya se han calculado.use_memsdebe establecerse enTruepara hacer uso demems. - perm_mask (
torch.Tensorde forma(batch_size, sequence_length, sequence_length), opcional) — Máscara para indicar el patrón de atención de cada token de entrada con valores seleccionados en[0, 1]:- si
perm_mask[k, i, j] = 0, i atiende a j en el lote k; - Si
perm_mask[k, i, j] = 1, i no atiende a j en el lote k.
Si no se establece, cada token atiende a todos los demás (atención bidireccional completa). Solo se utiliza durante el preentrenamiento (para definir el orden de factorización) o para la decodificación secuencial (generación).
- si
- target_mapping (
torch.Tensorde forma(batch_size, num_predict, sequence_length), opcional) — Máscara para indicar los tokens de salida a utilizar. Sitarget_mapping[k, i, j] = 1, la i-ésima predicción del lote k está en el j-ésimo token. Solo se utiliza durante el preentrenamiento para la predicción parcial o para la decodificación secuencial (generación). - token_type_ids (
torch.Tensorde forma(batch_size, sequence_length), opcional) — Índices de tokens de segmento para indicar las primeras y segundas partes de las entradas. Los índices se seleccionan en[0, 1]:- 0 corresponde a un token de sentence A,
- 1 corresponde a un token de sentence B.
- input_mask (
torch.Tensorde formabatch_size, sequence_length, opcional) — Máscara para evitar realizar atención en los índices de tokens de relleno. Negativo deattention_mask, es decir, con 0 para tokens reales y 1 para relleno, lo cual se mantiene por compatibilidad con la base de código original.Valores de máscara seleccionados en
[0, 1]:- 1 para los tokens que están mascarados,
- 0 para los tokens que no están enmascarados.
Solo puede usar uno de
input_maskyattention_mask. - inputs_embeds (
torch.Tensorde forma(batch_size, sequence_length, hidden_size), opcional) — Opcionalmente, en lugar de pasarinput_ids, puedes elegir pasar directamente una representación incrustada. Esto es útil si deseas tener más control sobre cómo convertir los índices deinput_idsen los vectores asociados que en la matriz de búsqueda de incrustaciones interna del modelo. - labels (
torch.LongTensorde forma(batch_size,), opcional) — Etiquetas para calcular la pérdida de clasificación/regresión de secuencia. Los índices deben estar en[0, ..., config.num_labels - 1]. Siconfig.num_labels == 1se calcula una pérdida de regresión (pérdida de error cuadrático medio), siconfig.num_labels > 1se calcula una pérdida de clasificación (entropía cruzada). - use_mems (
bool, opcional) — Indica si se deben usar estados de memoria para acelerar la decodificación secuencial. Si se establece enTrue, el modelo utilizará los estados ocultos de las pasadas anteriores para calcular la atención, lo que puede mejorar significativamente el rendimiento en tareas de decodificación secuencial. - output_attentions (
bool, opcional) — Indica si se deben devolver los tensores de atención de todas las capas de atención. Consulteattentionsen los tensores devueltos para obtener más detalles. - output_hidden_states (
bool, opcional) — Indica si se deben devolver los estados ocultos de todas las capas. Consultehidden_statesen los tensores devueltos para obtener más detalles. - return_dict (
bool, opcional) — Indica si se debe devolver un ModelOutput en lugar de una tupla simple.
Devuelve
XLNetForSequenceClassificationOutput o tuple(torch.Tensor)
Un XLNetForSequenceClassificationOutput o una tupla de
torch.Tensor (si se pasa return_dict=False o cuando config.return_dict=False) que comprende varios
elementos según la configuración (XLNetConfig) y las entradas.
El método forward de XLNetForSequenceClassification reemplaza el método especial __call__.
Aunque la receta para la pasada hacia adelante debe definirse dentro de esta función, se debe llamar a la instancia de
Moduledespués en lugar de a esta, ya que la primera se encarga de ejecutar los pasos de pre y postprocesamiento, mientras que la segunda los ignora silenciosamente.
loss (
torch.Tensorde forma(1,), opcional, se devuelve cuando se proporcionalabel) — Pérdida de clasificación (o de regresión si config.num_labels==1).logits (
torch.Tensorde forma(batch_size, config.num_labels)) — Puntuaciones de clasificación (o de regresión si config.num_labels==1) (antes de SoftMax).mems (
list[torch.Tensor]de longitudconfig.n_layers) — Contiene hidden-states precalculados. Se puede utilizar (ver entradamems) para acelerar la decodificación secuencial. Los ids de tokens cuyo pasado se ha proporcionado a este modelo no deben pasarse comoinput_idsya que ya han sido calculados.hidden_states (
tuple[torch.Tensor, ...], opcional, se devuelve cuando se pasaoutput_hidden_states=Trueo cuandoconfig.output_hidden_states=True) — Tupla detorch.Tensor(una para la salida de las incrustaciones, si el modelo tiene una capa de incrustaciones, + una para la salida de cada capa) de forma(batch_size, sequence_length, hidden_size).Estados ocultos del modelo en la salida de cada capa más las salidas opcionales de la incrustación inicial.
attentions (
tuple[torch.Tensor, ...], opcional, se devuelve cuando se pasaoutput_attentions=Trueo cuandoconfig.output_attentions=True) — Tupla detorch.Tensor(una por cada capa) de forma(batch_size, num_heads, sequence_length, sequence_length).Pesos de atención tras el softmax de atención, utilizados para calcular la media ponderada en las cabezas de autoatención.
Ejemplo de clasificación de una sola etiqueta:
>>> import torch
>>> from transformers import AutoTokenizer, XLNetForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("xlnet/xlnet-large-cased")
>>> model = XLNetForSequenceClassification.from_pretrained("xlnet/xlnet-large-cased")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
...
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = XLNetForSequenceClassification.from_pretrained("xlnet/xlnet-large-cased", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...Ejemplo de clasificación multietiqueta:
>>> import torch
>>> from transformers import AutoTokenizer, XLNetForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("xlnet/xlnet-large-cased")
>>> model = XLNetForSequenceClassification.from_pretrained("xlnet/xlnet-large-cased", problem_type="multi_label_classification")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = XLNetForSequenceClassification.from_pretrained(
... "xlnet/xlnet-large-cased", num_labels=num_labels, problem_type="multi_label_classification"
... )
>>> labels = torch.sum(
... torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).lossXLNetForMultipleChoice
clase transformers.XLNetForMultipleChoice
< source >( config: XLNetConfig )
Parámetros
- config (XLNetConfig) — Clase de configuración del modelo con todos los parámetros del modelo. Inicializar con un archivo de configuración no carga los pesos asociados con el modelo, solo la configuración. Consulte el método from_pretrained() para cargar los pesos del modelo.
El modelo Xlnet con una cabeza de clasificación de opción múltiple en la parte superior (una capa lineal sobre la salida agrupada y un softmax), por ejemplo, para las tareas RocStories/SWAG.
Este modelo hereda de PreTrainedModel. Consulta la documentación de la clase superior para los métodos genéricos que la biblioteca implementa para todos sus modelos (como la descarga o el guardado, el redimensionamiento de las incrustaciones de entrada, la poda de cabezas, etc.).
Este modelo también es una subclase de torch.nn.Module de PyTorch. Úsalo como un módulo de PyTorch regular y consulta la documentación de PyTorch para todo lo relacionado con el uso y el comportamiento generales.
forward
< source >( input_ids: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneinput_mask: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonemems: typing.Optional[torch.Tensor] = Noneperm_mask: typing.Optional[torch.Tensor] = Nonetarget_mapping: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.Tensor] = Noneuse_mems: bool | None = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → XLNetForMultipleChoiceOutput or tuple(torch.Tensor)
Parámetros
- input_ids (
torch.LongTensorde forma(batch_size, num_choices, sequence_length)) — Índices de los tokens de la secuencia de entrada en el vocabulario.Los índices se pueden obtener usando AutoTokenizer. Consulte PreTrainedTokenizer.encode() y PreTrainedTokenizer.call() para más detalles.
- token_type_ids (
torch.LongTensorde forma(batch_size, num_choices, sequence_length), opcional) — Índices de tokens de segmento para indicar las primeras y segundas partes de las entradas. Los índices se seleccionan en[0, 1]:- 0 corresponde a un token de sentence A,
- 1 corresponde a un token de sentence B.
- input_mask (
torch.Tensorde formabatch_size, num_choices, sequence_length, opcional) — Máscara para evitar realizar atención en los índices de tokens de relleno. Negativo deattention_mask, es decir, con 0 para tokens reales y 1 para relleno, que se mantiene por compatibilidad con la base de código original.Valores de máscara seleccionados en
[0, 1]:- 1 para los tokens que están mascarados,
- 0 para los tokens que no están enmascarados.
Solo puede usar uno de
input_maskyattention_mask. - attention_mask (
torch.Tensorde forma(batch_size, sequence_length), opcional) — Máscara para evitar realizar atención en los índices de tokens de relleno. Valores de máscara seleccionados en[0, 1]:- 1 para los tokens que no están enmascarados,
- 0 para los tokens que están enmascarados.
- mems (
list[torch.Tensor]de longitudconfig.n_layers) — Contiene estados ocultos precalculados (véase la salidamemsa continuación). Se puede usar para acelerar la decodificación secuencial. Los ids de tokens cuyo pasado se ha proporcionado a este modelo no deben pasarse comoinput_idsya que ya se han calculado.use_memsdebe establecerse enTruepara hacer uso demems. - perm_mask (
torch.Tensorde forma(batch_size, sequence_length, sequence_length), opcional) — Máscara para indicar el patrón de atención de cada token de entrada con valores seleccionados en[0, 1]:- si
perm_mask[k, i, j] = 0, i atiende a j en el lote k; - Si
perm_mask[k, i, j] = 1, i no atiende a j en el lote k.
Si no se establece, cada token atiende a todos los demás (atención bidireccional completa). Solo se utiliza durante el preentrenamiento (para definir el orden de factorización) o para la decodificación secuencial (generación).
- si
- target_mapping (
torch.Tensorde forma(batch_size, num_predict, sequence_length), opcional) — Máscara para indicar los tokens de salida a utilizar. Sitarget_mapping[k, i, j] = 1, la i-ésima predicción del lote k está en el j-ésimo token. Solo se utiliza durante el preentrenamiento para la predicción parcial o para la decodificación secuencial (generación). - inputs_embeds (
torch.Tensorde forma(batch_size, num_choices, sequence_length, hidden_size), opcional) — Opcionalmente, en lugar de pasarinput_ids, puedes elegir pasar directamente una representación incrustada. Esto es útil si deseas tener más control sobre cómo convertir los índices deinput_idsen los vectores asociados que en la matriz de búsqueda de incrustaciones interna del modelo. - labels (
torch.LongTensorde forma(batch_size,), opcional) — Etiquetas para calcular la pérdida de clasificación de opción múltiple. Los índices deben estar en `[0, …, - use_mems (
bool, opcional) — Indica si se deben usar estados de memoria para acelerar la decodificación secuencial. Si se establece enTrue, el modelo utilizará los estados ocultos de las pasadas anteriores para calcular la atención, lo que puede mejorar significativamente el rendimiento en tareas de decodificación secuencial. - output_attentions (
bool, opcional) — Indica si se deben devolver los tensores de atención de todas las capas de atención. Consulteattentionsen los tensores devueltos para obtener más detalles. - output_hidden_states (
bool, opcional) — Indica si se deben devolver los estados ocultos de todas las capas. Consultehidden_statesen los tensores devueltos para obtener más detalles. - return_dict (
bool, opcional) — Indica si se debe devolver un ModelOutput en lugar de una tupla simple.
Devuelve
XLNetForMultipleChoiceOutput o tuple(torch.Tensor)
Un XLNetForMultipleChoiceOutput o una tupla de
torch.Tensor (si se pasa return_dict=False o cuando config.return_dict=False) que comprende varios
elementos según la configuración (XLNetConfig) y las entradas.
El método forward de XLNetForMultipleChoice reemplaza el método especial __call__.
Aunque la receta para la pasada hacia adelante debe definirse dentro de esta función, se debe llamar a la instancia de
Moduledespués en lugar de a esta, ya que la primera se encarga de ejecutar los pasos de pre y postprocesamiento, mientras que la segunda los ignora silenciosamente.
loss (
torch.Tensorde forma (1,), opcional, devuelta cuando se proporcionalabels) — Pérdida de clasificación.logits (
torch.Tensorde forma(batch_size, num_choices)) — num_choices es la segunda dimensión de los tensores de entrada. (ver input_ids arriba).Puntuaciones de clasificación (antes de SoftMax).
mems (
list[torch.Tensor]de longitudconfig.n_layers) — Contiene hidden-states precalculados. Se puede utilizar (ver entradamems) para acelerar la decodificación secuencial. Los ids de tokens cuyo pasado se ha proporcionado a este modelo no deben pasarse comoinput_idsya que ya han sido calculados.hidden_states (
tuple[torch.Tensor, ...], opcional, se devuelve cuando se pasaoutput_hidden_states=Trueo cuandoconfig.output_hidden_states=True) — Tupla detorch.Tensor(una para la salida de las incrustaciones, si el modelo tiene una capa de incrustaciones, + una para la salida de cada capa) de forma(batch_size, sequence_length, hidden_size).Estados ocultos del modelo en la salida de cada capa más las salidas opcionales de la incrustación inicial.
attentions (
tuple[torch.Tensor, ...], opcional, se devuelve cuando se pasaoutput_attentions=Trueo cuandoconfig.output_attentions=True) — Tupla detorch.Tensor(una por cada capa) de forma(batch_size, num_heads, sequence_length, sequence_length).Pesos de atención tras el softmax de atención, utilizados para calcular la media ponderada en las cabezas de autoatención.
Ejemplo:
>>> from transformers import AutoTokenizer, XLNetForMultipleChoice
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("xlnet/xlnet-large-cased")
>>> model = XLNetForMultipleChoice.from_pretrained("xlnet/xlnet-large-cased")
>>> 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."
>>> labels = torch.tensor(0).unsqueeze(0) # choice0 is correct (according to Wikipedia ;)), batch size 1
>>> encoding = tokenizer([prompt, prompt], [choice0, choice1], return_tensors="pt", padding=True)
>>> outputs = model(**{k: v.unsqueeze(0) for k, v in encoding.items()}, labels=labels) # batch size is 1
>>> # the linear classifier still needs to be trained
>>> loss = outputs.loss
>>> logits = outputs.logitsXLNetForTokenClassification
clase transformers.XLNetForTokenClassification
< source >( config: XLNetConfig )
Parámetros
- config (XLNetConfig) — Clase de configuración del modelo con todos los parámetros del modelo. Inicializar con un archivo de configuración no carga los pesos asociados con el modelo, solo la configuración. Consulte el método from_pretrained() para cargar los pesos del modelo.
El transformer Xlnet con una cabeza de clasificación de tokens en la parte superior (una capa lineal sobre la salida de los hidden-states), por ejemplo, para tareas de reconocimiento de entidades nombradas (NER).
Este modelo hereda de PreTrainedModel. Consulta la documentación de la clase superior para los métodos genéricos que la biblioteca implementa para todos sus modelos (como la descarga o el guardado, el redimensionamiento de las incrustaciones de entrada, la poda de cabezas, etc.).
Este modelo también es una subclase de torch.nn.Module de PyTorch. Úsalo como un módulo de PyTorch regular y consulta la documentación de PyTorch para todo lo relacionado con el uso y el comportamiento generales.
forward
< source >( input_ids: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonemems: typing.Optional[torch.Tensor] = Noneperm_mask: typing.Optional[torch.Tensor] = Nonetarget_mapping: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneinput_mask: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.Tensor] = Noneuse_mems: bool | None = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → XLNetForTokenClassificationOutput or tuple(torch.Tensor)
Parámetros
- input_ids (
torch.Tensorde forma(batch_size, sequence_length), opcional) — Índices de los tokens de la secuencia de entrada en el vocabulario. El relleno se ignorará de forma predeterminada.Los índices se pueden obtener usando AutoTokenizer. Consulte PreTrainedTokenizer.encode() y PreTrainedTokenizer.call() para más detalles.
- attention_mask (
torch.Tensorde forma(batch_size, sequence_length), opcional) — Máscara para evitar realizar atención en los índices de tokens de relleno. Valores de máscara seleccionados en[0, 1]:- 1 para los tokens que no están enmascarados,
- 0 para los tokens que están enmascarados.
- mems (
list[torch.Tensor]de longitudconfig.n_layers) — Contiene estados ocultos precalculados (véase la salidamemsa continuación). Se puede usar para acelerar la decodificación secuencial. Los ids de tokens cuyo pasado se ha proporcionado a este modelo no deben pasarse comoinput_idsya que ya se han calculado.use_memsdebe establecerse enTruepara hacer uso demems. - perm_mask (
torch.Tensorde forma(batch_size, sequence_length, sequence_length), opcional) — Máscara para indicar el patrón de atención de cada token de entrada con valores seleccionados en[0, 1]:- si
perm_mask[k, i, j] = 0, i atiende a j en el lote k; - Si
perm_mask[k, i, j] = 1, i no atiende a j en el lote k.
Si no se establece, cada token atiende a todos los demás (atención bidireccional completa). Solo se utiliza durante el preentrenamiento (para definir el orden de factorización) o para la decodificación secuencial (generación).
- si
- target_mapping (
torch.Tensorde forma(batch_size, num_predict, sequence_length), opcional) — Máscara para indicar los tokens de salida a utilizar. Sitarget_mapping[k, i, j] = 1, la i-ésima predicción del lote k está en el j-ésimo token. Solo se utiliza durante el preentrenamiento para la predicción parcial o para la decodificación secuencial (generación). - token_type_ids (
torch.Tensorde forma(batch_size, sequence_length), opcional) — Índices de tokens de segmento para indicar las primeras y segundas partes de las entradas. Los índices se seleccionan en[0, 1]:- 0 corresponde a un token de sentence A,
- 1 corresponde a un token de sentence B.
- input_mask (
torch.Tensorde formabatch_size, sequence_length, opcional) — Máscara para evitar realizar atención en los índices de tokens de relleno. Negativo deattention_mask, es decir, con 0 para tokens reales y 1 para relleno, lo cual se mantiene por compatibilidad con la base de código original.Valores de máscara seleccionados en
[0, 1]:- 1 para los tokens que están mascarados,
- 0 para los tokens que no están enmascarados.
Solo puede usar uno de
input_maskyattention_mask. - inputs_embeds (
torch.Tensorde forma(batch_size, sequence_length, hidden_size), opcional) — Opcionalmente, en lugar de pasarinput_ids, puedes elegir pasar directamente una representación incrustada. Esto es útil si deseas tener más control sobre cómo convertir los índices deinput_idsen los vectores asociados que en la matriz de búsqueda de incrustaciones interna del modelo. - labels (
torch.LongTensorde forma(batch_size,), opcional) — Etiquetas para calcular la pérdida de clasificación de opción múltiple. Los índices deben estar en[0, ..., num_choices]donde num_choices es el tamaño de la segunda dimensión de los tensores de entrada. (ver input_ids arriba) - use_mems (
bool, opcional) — Indica si se deben usar estados de memoria para acelerar la decodificación secuencial. Si se establece enTrue, el modelo utilizará los estados ocultos de las pasadas anteriores para calcular la atención, lo que puede mejorar significativamente el rendimiento en tareas de decodificación secuencial. Estados de memoria para acelerar la decodificación secuencial. Si se establece enTrue, el modelo utilizará los estados ocultos de las pasadas anteriores para calcular la atención, lo que puede mejorar significativamente el rendimiento en tareas de decodificación secuencial. - output_attentions (
bool, opcional) — Indica si se deben devolver los tensores de atención de todas las capas de atención. Consulteattentionsen los tensores devueltos para obtener más detalles. - output_hidden_states (
bool, opcional) — Indica si se deben devolver los estados ocultos de todas las capas. Consultehidden_statesen los tensores devueltos para obtener más detalles. - return_dict (
bool, opcional) — Indica si se debe devolver un ModelOutput en lugar de una tupla simple.
Devuelve
XLNetForTokenClassificationOutput o tuple(torch.Tensor)
Un XLNetForTokenClassificationOutput o una tupla de
torch.Tensor (si se pasa return_dict=False o cuando config.return_dict=False) que comprende varios
elementos según la configuración (XLNetConfig) y las entradas.
El método forward de XLNetForTokenClassification reemplaza el método especial __call__.
Aunque la receta para la pasada hacia adelante debe definirse dentro de esta función, se debe llamar a la instancia de
Moduledespués en lugar de a esta, ya que la primera se encarga de ejecutar los pasos de pre y postprocesamiento, mientras que la segunda los ignora silenciosamente.
loss (
torch.Tensorde forma(1,), opcional, se devuelve cuando se proporcionalabels) — Pérdida de clasificación.logits (
torch.Tensorde forma(batch_size, sequence_length, config.num_labels)) — Puntuaciones de clasificación (antes de SoftMax).mems (
list[torch.Tensor]de longitudconfig.n_layers) — Contiene hidden-states precalculados. Se puede utilizar (ver entradamems) para acelerar la decodificación secuencial. Los ids de tokens cuyo pasado se ha proporcionado a este modelo no deben pasarse comoinput_idsya que ya han sido calculados.hidden_states (
tuple[torch.Tensor, ...], opcional, se devuelve cuando se pasaoutput_hidden_states=Trueo cuandoconfig.output_hidden_states=True) — Tupla detorch.Tensor(una para la salida de las incrustaciones, si el modelo tiene una capa de incrustaciones, + una para la salida de cada capa) de forma(batch_size, sequence_length, hidden_size).Estados ocultos del modelo en la salida de cada capa más las salidas opcionales de la incrustación inicial.
attentions (
tuple[torch.Tensor, ...], opcional, se devuelve cuando se pasaoutput_attentions=Trueo cuandoconfig.output_attentions=True) — Tupla detorch.Tensor(una por cada capa) de forma(batch_size, num_heads, sequence_length, sequence_length).Pesos de atención tras el softmax de atención, utilizados para calcular la media ponderada en las cabezas de autoatención.
Ejemplo:
>>> from transformers import AutoTokenizer, XLNetForTokenClassification
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("xlnet/xlnet-large-cased")
>>> model = XLNetForTokenClassification.from_pretrained("xlnet/xlnet-large-cased")
>>> inputs = tokenizer(
... "HuggingFace is a company based in Paris and New York", add_special_tokens=False, return_tensors="pt"
... )
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_token_class_ids = logits.argmax(-1)
>>> # Note that tokens are classified rather then input words which means that
>>> # there might be more predicted token classes than words.
>>> # Multiple token classes might account for the same word
>>> predicted_tokens_classes = [model.config.id2label[t.item()] for t in predicted_token_class_ids[0]]
>>> predicted_tokens_classes
...
>>> labels = predicted_token_class_ids
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...XLNetForQuestionAnsweringSimple
clase transformers.XLNetForQuestionAnsweringSimple
< source >( config: XLNetConfig )
Parámetros
- config (XLNetConfig) — Clase de configuración del modelo con todos los parámetros del modelo. Inicializar con un archivo de configuración no carga los pesos asociados con el modelo, solo la configuración. Consulte el método from_pretrained() para cargar los pesos del modelo.
Modelo XLNet con una cabeza de clasificación de tramos en la parte superior para tareas de respuesta a preguntas extractivas como SQuAD (una capa lineal sobre la salida de los estados ocultos para calcular span start logits y span end logits).
Este modelo hereda de PreTrainedModel. Consulta la documentación de la clase superior para los métodos genéricos que la biblioteca implementa para todos sus modelos (como la descarga o el guardado, el redimensionamiento de las incrustaciones de entrada, la poda de cabezas, etc.).
Este modelo también es una subclase de torch.nn.Module de PyTorch. Úsalo como un módulo de PyTorch regular y consulta la documentación de PyTorch para todo lo relacionado con el uso y el comportamiento generales.
forward
< source >( input_ids: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonemems: typing.Optional[torch.Tensor] = Noneperm_mask: typing.Optional[torch.Tensor] = Nonetarget_mapping: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneinput_mask: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonestart_positions: typing.Optional[torch.Tensor] = Noneend_positions: typing.Optional[torch.Tensor] = Noneuse_mems: bool | None = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → XLNetForQuestionAnsweringSimpleOutput or tuple(torch.Tensor)
Parámetros
- input_ids (
torch.Tensorde forma(batch_size, sequence_length), opcional) — Índices de los tokens de la secuencia de entrada en el vocabulario. El relleno se ignorará de forma predeterminada.Los índices se pueden obtener usando AutoTokenizer. Consulte PreTrainedTokenizer.encode() y PreTrainedTokenizer.call() para más detalles.
- attention_mask (
torch.Tensorde forma(batch_size, sequence_length), opcional) — Máscara para evitar realizar atención en los índices de tokens de relleno. Valores de máscara seleccionados en[0, 1]:- 1 para los tokens que no están enmascarados,
- 0 para los tokens que están enmascarados.
- mems (
list[torch.Tensor]de longitudconfig.n_layers) — Contiene estados ocultos precalculados (véase la salidamemsa continuación). Se puede usar para acelerar la decodificación secuencial. Los ids de tokens cuyo pasado se ha proporcionado a este modelo no deben pasarse comoinput_idsya que ya se han calculado.use_memsdebe establecerse enTruepara hacer uso demems. - perm_mask (
torch.Tensorde forma(batch_size, sequence_length, sequence_length), opcional) — Máscara para indicar el patrón de atención de cada token de entrada con valores seleccionados en[0, 1]:- si
perm_mask[k, i, j] = 0, i atiende a j en el lote k; - Si
perm_mask[k, i, j] = 1, i no atiende a j en el lote k.
Si no se establece, cada token atiende a todos los demás (atención bidireccional completa). Solo se utiliza durante el preentrenamiento (para definir el orden de factorización) o para la decodificación secuencial (generación).
- si
- target_mapping (
torch.Tensorde forma(batch_size, num_predict, sequence_length), opcional) — Máscara para indicar los tokens de salida a utilizar. Sitarget_mapping[k, i, j] = 1, la i-ésima predicción del lote k está en el j-ésimo token. Solo se utiliza durante el preentrenamiento para la predicción parcial o para la decodificación secuencial (generación). - token_type_ids (
torch.Tensorde forma(batch_size, sequence_length), opcional) — Índices de tokens de segmento para indicar las primeras y segundas partes de las entradas. Los índices se seleccionan en[0, 1]:- 0 corresponde a un token de sentence A,
- 1 corresponde a un token de sentence B.
- input_mask (
torch.Tensorde formabatch_size, sequence_length, opcional) — Máscara para evitar realizar atención en los índices de tokens de relleno. Negativo deattention_mask, es decir, con 0 para tokens reales y 1 para relleno, lo cual se mantiene por compatibilidad con la base de código original.Valores de máscara seleccionados en
[0, 1]:- 1 para los tokens que están mascarados,
- 0 para los tokens que no están enmascarados.
Solo puede usar uno de
input_maskyattention_mask. - inputs_embeds (
torch.Tensorde forma(batch_size, sequence_length, hidden_size), opcional) — Opcionalmente, en lugar de pasarinput_ids, puedes elegir pasar directamente una representación incrustada. Esto es útil si deseas tener más control sobre cómo convertir los índices deinput_idsen los vectores asociados que en la matriz de búsqueda de incrustaciones interna del modelo. - start_positions (
torch.Tensorde forma(batch_size,), opcional) — Etiquetas para la posición (índice) del inicio del span etiquetado para calcular la pérdida de clasificación de tokens. Las posiciones se limitan a la longitud de la secuencia (sequence_length). Las posiciones fuera de la secuencia no se tienen en cuenta para calcular la pérdida. - end_positions (
torch.Tensorde forma(batch_size,), opcional) — Etiquetas para la posición (índice) del final del span etiquetado para calcular la pérdida de clasificación de tokens. Las posiciones se limitan a la longitud de la secuencia (sequence_length). Las posiciones fuera de la secuencia no se tienen en cuenta para calcular la pérdida. - use_mems (
bool, opcional) — Indica si se deben usar estados de memoria para acelerar la decodificación secuencial. Si se establece enTrue, el modelo utilizará los estados ocultos de las pasadas anteriores para calcular la atención, lo que puede mejorar significativamente el rendimiento en tareas de decodificación secuencial. - output_attentions (
bool, opcional) — Indica si se deben devolver los tensores de atención de todas las capas de atención. Consulteattentionsen los tensores devueltos para obtener más detalles. - output_hidden_states (
bool, opcional) — Indica si se deben devolver los estados ocultos de todas las capas. Consultehidden_statesen los tensores devueltos para obtener más detalles. - return_dict (
bool, opcional) — Indica si se debe devolver un ModelOutput en lugar de una tupla simple.
Devuelve
XLNetForQuestionAnsweringSimpleOutput o tuple(torch.Tensor)
Un XLNetForQuestionAnsweringSimpleOutput o una tupla de
torch.Tensor (si se pasa return_dict=False o cuando config.return_dict=False) que comprende varios
elementos según la configuración (XLNetConfig) y las entradas.
El método forward de XLNetForQuestionAnsweringSimple sobrescribe el método especial __call__.
Aunque la receta para la pasada hacia adelante debe definirse dentro de esta función, se debe llamar a la instancia de
Moduledespués en lugar de a esta, ya que la primera se encarga de ejecutar los pasos de pre y postprocesamiento, mientras que la segunda los ignora silenciosamente.
loss (
torch.Tensorde forma(1,), opcional, se devuelve cuando se proporcionalabels) — La pérdida total de extracción de tramos es la suma de una Entropía Cruzada para las posiciones de inicio y fin.start_logits (
torch.Tensorde forma(batch_size, sequence_length,)) — Puntuaciones de inicio de tramo (antes de SoftMax).end_logits (
torch.Tensorde forma(batch_size, sequence_length,)) — Puntuaciones de fin de tramo (antes de SoftMax).mems (
list[torch.Tensor]de longitudconfig.n_layers) — Contiene hidden-states precalculados. Se puede utilizar (ver entradamems) para acelerar la decodificación secuencial. Los ids de tokens cuyo pasado se ha proporcionado a este modelo no deben pasarse comoinput_idsya que ya han sido calculados.hidden_states (
tuple[torch.Tensor, ...], opcional, se devuelve cuando se pasaoutput_hidden_states=Trueo cuandoconfig.output_hidden_states=True) — Tupla detorch.Tensor(una para la salida de las incrustaciones, si el modelo tiene una capa de incrustaciones, + una para la salida de cada capa) de forma(batch_size, sequence_length, hidden_size).Estados ocultos del modelo en la salida de cada capa más las salidas opcionales de la incrustación inicial.
attentions (
tuple[torch.Tensor, ...], opcional, se devuelve cuando se pasaoutput_attentions=Trueo cuandoconfig.output_attentions=True) — Tupla detorch.Tensor(una por cada capa) de forma(batch_size, num_heads, sequence_length, sequence_length).Pesos de atención tras el softmax de atención, utilizados para calcular la media ponderada en las cabezas de autoatención.
Ejemplo:
>>> from transformers import AutoTokenizer, XLNetForQuestionAnsweringSimple
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("xlnet/xlnet-large-cased")
>>> model = XLNetForQuestionAnsweringSimple.from_pretrained("xlnet/xlnet-large-cased")
>>> question, text = "Who was Jim Henson?", "Jim Henson was a nice puppet"
>>> inputs = tokenizer(question, text, return_tensors="pt")
>>> with torch.no_grad():
... outputs = model(**inputs)
>>> answer_start_index = outputs.start_logits.argmax()
>>> answer_end_index = outputs.end_logits.argmax()
>>> predict_answer_tokens = inputs.input_ids[0, answer_start_index : answer_end_index + 1]
>>> tokenizer.decode(predict_answer_tokens, skip_special_tokens=True)
...
>>> # target is "nice puppet"
>>> target_start_index = torch.tensor([14])
>>> target_end_index = torch.tensor([15])
>>> outputs = model(**inputs, start_positions=target_start_index, end_positions=target_end_index)
>>> loss = outputs.loss
>>> round(loss.item(), 2)
...XLNetForQuestionAnswering
clase transformers.XLNetForQuestionAnswering
< source >( config: XLNetConfig )
Parámetros
- config (XLNetConfig) — Clase de configuración del modelo con todos los parámetros del modelo. Inicializar con un archivo de configuración no carga los pesos asociados con el modelo, solo la configuración. Consulte el método from_pretrained() para cargar los pesos del modelo.
El transformador Xlnet con una cabeza de clasificación de tramos en la parte superior para tareas de respuesta a preguntas extractivas como SQuAD (una capa lineal sobre la salida de los estados ocultos para calcular span start logits y span end logits).
Este modelo hereda de PreTrainedModel. Consulta la documentación de la clase superior para los métodos genéricos que la biblioteca implementa para todos sus modelos (como la descarga o el guardado, el redimensionamiento de las incrustaciones de entrada, la poda de cabezas, etc.).
Este modelo también es una subclase de torch.nn.Module de PyTorch. Úsalo como un módulo de PyTorch regular y consulta la documentación de PyTorch para todo lo relacionado con el uso y el comportamiento generales.
forward
< source >( input_ids: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonemems: typing.Optional[torch.Tensor] = Noneperm_mask: typing.Optional[torch.Tensor] = Nonetarget_mapping: typing.Optional[torch.Tensor] = Nonetoken_type_ids: typing.Optional[torch.Tensor] = Noneinput_mask: typing.Optional[torch.Tensor] = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonestart_positions: typing.Optional[torch.Tensor] = Noneend_positions: typing.Optional[torch.Tensor] = Noneis_impossible: typing.Optional[torch.Tensor] = Nonecls_index: typing.Optional[torch.Tensor] = Nonep_mask: typing.Optional[torch.Tensor] = Noneuse_mems: bool | None = Noneoutput_attentions: bool | None = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → XLNetForQuestionAnsweringOutput or tuple(torch.Tensor)
Parámetros
- input_ids (
torch.Tensorde forma(batch_size, sequence_length), opcional) — Índices de los tokens de la secuencia de entrada en el vocabulario. El relleno se ignorará de forma predeterminada.Los índices se pueden obtener usando AutoTokenizer. Consulte PreTrainedTokenizer.encode() y PreTrainedTokenizer.call() para más detalles.
- attention_mask (
torch.Tensorde forma(batch_size, sequence_length), opcional) — Máscara para evitar realizar atención en los índices de tokens de relleno. Valores de máscara seleccionados en[0, 1]:- 1 para los tokens que no están enmascarados,
- 0 para los tokens que están enmascarados.
- mems (
list[torch.Tensor]de longitudconfig.n_layers) — Contiene estados ocultos precalculados (véase la salidamemsa continuación). Se puede usar para acelerar la decodificación secuencial. Los ids de tokens cuyo pasado se ha proporcionado a este modelo no deben pasarse comoinput_idsya que ya se han calculado.use_memsdebe establecerse enTruepara hacer uso demems. - perm_mask (
torch.Tensorde forma(batch_size, sequence_length, sequence_length), opcional) — Máscara para indicar el patrón de atención de cada token de entrada con valores seleccionados en[0, 1]:- si
perm_mask[k, i, j] = 0, i atiende a j en el lote k; - Si
perm_mask[k, i, j] = 1, i no atiende a j en el lote k.
Si no se establece, cada token atiende a todos los demás (atención bidireccional completa). Solo se utiliza durante el preentrenamiento (para definir el orden de factorización) o para la decodificación secuencial (generación).
- si
- target_mapping (
torch.Tensorde forma(batch_size, num_predict, sequence_length), opcional) — Máscara para indicar los tokens de salida a utilizar. Sitarget_mapping[k, i, j] = 1, la i-ésima predicción del lote k está en el j-ésimo token. Solo se utiliza durante el preentrenamiento para la predicción parcial o para la decodificación secuencial (generación). - token_type_ids (
torch.Tensorde forma(batch_size, sequence_length), opcional) — Índices de tokens de segmento para indicar las primeras y segundas partes de las entradas. Los índices se seleccionan en[0, 1]:- 0 corresponde a un token de sentence A,
- 1 corresponde a un token de sentence B.
- input_mask (
torch.Tensorde formabatch_size, sequence_length, opcional) — Máscara para evitar realizar atención en los índices de tokens de relleno. Negativo deattention_mask, es decir, con 0 para tokens reales y 1 para relleno, lo cual se mantiene por compatibilidad con la base de código original.Valores de máscara seleccionados en
[0, 1]:- 1 para los tokens que están mascarados,
- 0 para los tokens que no están enmascarados.
Solo puede usar uno de
input_maskyattention_mask. - inputs_embeds (
torch.Tensorde forma(batch_size, sequence_length, hidden_size), opcional) — Opcionalmente, en lugar de pasarinput_ids, puedes elegir pasar directamente una representación incrustada. Esto es útil si deseas tener más control sobre cómo convertir los índices deinput_idsen los vectores asociados que en la matriz de búsqueda de incrustaciones interna del modelo. - start_positions (
torch.Tensorde forma(batch_size,), opcional) — Etiquetas para la posición (índice) del inicio del span etiquetado para calcular la pérdida de clasificación de tokens. Las posiciones se limitan a la longitud de la secuencia (sequence_length). Las posiciones fuera de la secuencia no se tienen en cuenta para calcular la pérdida. - end_positions (
torch.Tensorde forma(batch_size,), opcional) — Etiquetas para la posición (índice) del final del span etiquetado para calcular la pérdida de clasificación de tokens. Las posiciones se limitan a la longitud de la secuencia (sequence_length). Las posiciones fuera de la secuencia no se tienen en cuenta para calcular la pérdida. - is_impossible (
torch.LongTensorde forma(batch_size,), opcional) — Etiquetas que indican si una pregunta tiene respuesta o no (SQuAD 2.0) - cls_index (
torch.LongTensorde forma(batch_size,), opcional) — Etiquetas para la posición (índice) del token de clasificación que se utilizará como entrada para calcular la plausibilidad de la respuesta. - p_mask (
torch.Tensorde forma(batch_size, sequence_length), opcional) — Máscara opcional de tokens que no pueden estar en las respuestas (p. ej. [CLS], [PAD], …). 1.0 significa que el token debe enmascararse. 0.0 significa que el token no está enmascarado. - use_mems (
bool, opcional) — Indica si se deben usar estados de memoria para acelerar la decodificación secuencial. Si se establece enTrue, el modelo utilizará los estados ocultos de las pasadas anteriores para calcular la atención, lo que puede mejorar significativamente el rendimiento en tareas de decodificación secuencial. - output_attentions (
bool, opcional) — Indica si se deben devolver los tensores de atención de todas las capas de atención. Consulteattentionsen los tensores devueltos para obtener más detalles. - output_hidden_states (
bool, opcional) — Indica si se deben devolver los estados ocultos de todas las capas. Consultehidden_statesen los tensores devueltos para obtener más detalles. - return_dict (
bool, opcional) — Indica si se debe devolver un ModelOutput en lugar de una tupla simple.
Devuelve
XLNetForQuestionAnsweringOutput o tuple(torch.Tensor)
Un XLNetForQuestionAnsweringOutput o una tupla de
torch.Tensor (si se pasa return_dict=False o cuando config.return_dict=False) que comprende varios
elementos según la configuración (XLNetConfig) y las entradas.
El método forward de XLNetForQuestionAnswering reemplaza el método especial __call__.
Aunque la receta para la pasada hacia adelante debe definirse dentro de esta función, se debe llamar a la instancia de
Moduledespués en lugar de a esta, ya que la primera se encarga de ejecutar los pasos de pre y postprocesamiento, mientras que la segunda los ignora silenciosamente.
loss (
torch.Tensorde forma(1,), opcional, se devuelve si se proporcionan tantostart_positionscomoend_positions) — Pérdida de clasificación como la suma de las pérdidas de clasificación del token de inicio, del token de finalización (y de is_impossible si se proporciona).start_top_log_probs (
torch.Tensorde forma(batch_size, config.start_n_top), opcional, se devuelve si no se proporcionastart_positionsoend_positions) — Probabilidades logarítmicas para las config.start_n_top posibilidades de tokens de inicio (beam-search).start_top_index (
torch.LongTensorde forma(batch_size, config.start_n_top), opcional, se devuelve si no se proporcionastart_positionsoend_positions) — Índices para las config.start_n_top posibilidades de inicio de token (búsqueda por haz).end_top_log_probs (
torch.Tensorde forma(batch_size, config.start_n_top * config.end_n_top), opcional, se devuelve si no se proporcionastart_positionsoend_positions) — Probabilidades logarítmicas para lasconfig.start_n_top * config.end_n_topposibilidades de tokens finales más probables (beam-search).end_top_index (
torch.LongTensorde forma(batch_size, config.start_n_top * config.end_n_top), opcional, se devuelve si no se proporcionastart_positionsoend_positions) — Índices para lasconfig.start_n_top * config.end_n_topposibilidades de tokens finales (beam-search).cls_logits (
torch.Tensorde forma(batch_size,), opcional, se devuelve si no se proporcionastart_positionsoend_positions) — Probabilidades logarítmicas para la etiquetais_impossiblede las respuestas.mems (
list[torch.Tensor]de longitudconfig.n_layers) — Contiene hidden-states precalculados. Se puede utilizar (ver entradamems) para acelerar la decodificación secuencial. Los ids de tokens cuyo pasado se ha proporcionado a este modelo no deben pasarse comoinput_idsya que ya han sido calculados.hidden_states (
tuple[torch.Tensor, ...], opcional, se devuelve cuando se pasaoutput_hidden_states=Trueo cuandoconfig.output_hidden_states=True) — Tupla detorch.Tensor(una para la salida de las incrustaciones, si el modelo tiene una capa de incrustaciones, + una para la salida de cada capa) de forma(batch_size, sequence_length, hidden_size).Estados ocultos del modelo en la salida de cada capa más las salidas opcionales de la incrustación inicial.
attentions (
tuple[torch.Tensor, ...], opcional, se devuelve cuando se pasaoutput_attentions=Trueo cuandoconfig.output_attentions=True) — Tupla detorch.Tensor(una por cada capa) de forma(batch_size, num_heads, sequence_length, sequence_length).Pesos de atención tras el softmax de atención, utilizados para calcular la media ponderada en las cabezas de autoatención.
Ejemplo:
>>> from transformers import AutoTokenizer, XLNetForQuestionAnswering
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("xlnet/xlnet-base-cased")
>>> model = XLNetForQuestionAnswering.from_pretrained("xlnet/xlnet-base-cased")
>>> input_ids = torch.tensor(tokenizer.encode("Hello, my dog is cute", add_special_tokens=True)).unsqueeze(
... 0
... ) # Batch size 1
>>> start_positions = torch.tensor([1])
>>> end_positions = torch.tensor([3])
>>> outputs = model(input_ids, start_positions=start_positions, end_positions=end_positions)
>>> loss = outputs.loss