# Informer

## Visão geral

O modelo Informer foi proposto em [Informer: Beyond Efficient Transformer for Long Sequence Time-Series Forecasting](https://huggingface.co/papers/2012.07436) por Haoyi Zhou, Shanghang Zhang, Jieqi Peng, Shuai Zhang, Jianxin Li, Hui Xiong e Wancai Zhang.

Este método introduz um mecanismo de Atenção Probabilística para selecionar as consultas "ativas" em vez das consultas "preguiçosas" e fornece um Transformer esparsa, mitigando assim os requisitos quadráticos de computação e memória da atenção vanilla.

O resumo do artigo é o seguinte:

*Muitas aplicações do mundo real exigem a previsão de séries temporais de longa sequência, como o planejamento do consumo de eletricidade. A previsão de séries temporais de longa sequência (LSTF) exige uma alta capacidade de previsão do modelo, ou seja, a capacidade de capturar com eficiência o acoplamento de dependência de longo alcance entre a saída e a entrada. Estudos recentes demonstraram o potencial do Transformer para aumentar a capacidade de previsão. No entanto, existem vários problemas graves no Transformer que impedem sua aplicação direta à LSTF, incluindo a complexidade temporal quadrática, o alto uso de memória e a limitação inerente da arquitetura encoder-decoder. Para resolver esses problemas, projetamos um modelo eficiente baseado em Transformer para LSTF, chamado Informer, com três características distintas: (i) um mecanismo de autoatenção ProbSparse, que atinge O(L logL) em complexidade temporal e uso de memória, e apresenta desempenho comparável no alinhamento de dependências das sequências. (ii) a destilação de autoatenção destaca a atenção dominante ao reduzir pela metade a entrada da camada em cascata, e lida de forma eficiente com sequências de entrada extremamente longas. (iii) o decodificador de estilo generativo, embora conceitualmente simples, prevê as sequências de séries temporais longas em uma única operação de encaminhamento, em vez de uma abordagem passo a passo, o que melhora drasticamente a velocidade de inferência de previsões de sequência longa. Experimentos extensivos em quatro conjuntos de dados em larga escala demonstram que o Informer supera significativamente os métodos existentes e oferece uma nova solução para o problema da LSTF.*

Este modelo foi contribuído por [elisim](https://huggingface.co/elisim) e [kashif](https://huggingface.co/kashif). O código original pode ser encontrado [aqui](https://github.com/zhouhaoyi/Informer2020).

## Recursos

Uma lista de recursos oficiais do Hugging Face e da comunidade (indicados por 🌎) para ajudar você a começar. Se você tiver interesse em enviar um recurso para ser incluído aqui, sinta-se à vontade para abrir um Pull Request e faremos a revisão! O recurso deve, idealmente, demonstrar algo novo, em vez de duplicar um recurso existente.

- Confira o post no blog do HuggingFace: [Multivariate Probabilistic Time Series Forecasting with Informer](https://huggingface.co/blog/informer)

## InformerConfig[[transformers.InformerConfig]]

#### transformers.InformerConfig[[transformers.InformerConfig]]

```python
transformers.InformerConfig(transformers_version: str | None = None, architectures: list[str] | None = None, output_hidden_states: bool | None = False, return_dict: bool | None = True, dtype: str | torch.dtype | None = None, chunk_size_feed_forward: int = 0, id2label: dict[int, str] | dict[str, str] | None = None, label2id: dict[str, int] | dict[str, str] | None = None, problem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = None, is_encoder_decoder: bool = True, prediction_length: int | None = None, context_length: int | None = None, distribution_output: str = 'student_t', loss: str = 'nll', input_size: int = 1, lags_sequence: list[int] | None = None, scaling: str | bool | None = 'mean', num_dynamic_real_features: int = 0, num_static_real_features: int = 0, num_static_categorical_features: int = 0, num_time_features: int = 0, cardinality: list[int] | None = None, embedding_dimension: list[int] | None = None, d_model: int = 64, encoder_ffn_dim: int = 32, decoder_ffn_dim: int = 32, encoder_attention_heads: int = 2, decoder_attention_heads: int = 2, encoder_layers: int = 2, decoder_layers: int = 2, activation_function: str = 'gelu', dropout: float | int = 0.05, encoder_layerdrop: float | int = 0.1, decoder_layerdrop: float | int = 0.1, attention_dropout: float | int = 0.1, activation_dropout: float | int = 0.1, num_parallel_samples: int = 100, init_std: float = 0.02, use_cache: bool = True, attention_type: str = 'prob', sampling_factor: int = 5, distil: bool = True)
```

[Origem](https://github.com/huggingface/transformers/blob/main/src/transformers/models/informer/configuration_informer.py#L24)

**Parâmetros:**

is_encoder_decoder (`bool`, *opcional*, padrão `True`) : Indica se o modelo é usado como codificador/decodificador ou não.

prediction_length (`int`, *opcional*) : O comprimento da previsão para o decodificador. Em outras palavras, o horizonte de previsão do modelo. Este valor é geralmente determinado pelo conjunto de dados e recomendamos configurá-lo adequadamente.

context_length (`int`, *opcional*, padrão `prediction_length`) : O comprimento do contexto para o codificador. Se `None`, o comprimento do contexto será o mesmo que o `prediction_length`.

distribution_output (`string`, *opcional*, padrão `"student_t"`) : A cabeça de emissão de distribuição do modelo. Pode ser "student_t", "normal" ou "negative_binomial".

loss (`string`, *opcional*, padrão `"nll"`) : A função de perda do modelo correspondente ao cabeçalho `distribution_output`. Para distribuições paramétricas, é a log-verossimilhança negativa (nll) - que atualmente é a única suportada.

input_size (`int`, *opcional*, padrão 1) : O tamanho da variável alvo, que por padrão é 1 para alvos univariados. Será > 1 no caso de alvos multivariados.

lags_sequence (`list[int]`, *opcional*, padrão `[1, 2, 3, 4, 5, 6, 7]`) : Os defasagens da série temporal de entrada como covariáveis, frequentemente ditados pela frequência dos dados. O padrão é `[1, 2, 3, 4, 5, 6, 7]`, mas recomendamos alterá-lo de acordo com o conjunto de dados.

scaling (`string` ou `bool`, *opcional*, padrão `"mean"`) : Se os alvos de entrada devem ser escalados usando o escaler "mean", o escaler "std" ou nenhum escaler, se `None`. Se `True`, o escaler é definido como "mean".

num_dynamic_real_features (`int`, *opcional*, padrão 0) : O número de recursos dinâmicos com valores reais.

num_static_real_features (`int`, *opcional*, padrão 0) : O número de características reais estáticas.

num_static_categorical_features (`int`, *opcional*, padrão 0) : O número de características categóricas estáticas.

num_time_features (`int`, *opcional*, padrão 0) : O número de recursos temporais na série temporal de entrada.

cardinality (`list[int]`, *opcional*) : A cardinalidade (número de valores distintos) para cada uma das características categóricas estáticas. Deve ser uma lista de inteiros, com o mesmo comprimento que `num_static_categorical_features`. Não pode ser `None` se `num_static_categorical_features` for > 0.

embedding_dimension (`list[int]`, *opcional*) : A dimensão do embedding para cada uma das características categóricas estáticas. Deve ser uma lista de inteiros, com o mesmo comprimento que `num_static_categorical_features`. Não pode ser `None` se `num_static_categorical_features` for > 0.

d_model (`int`, *opcional*, padrão `64`) : Tamanho das camadas do codificador e da camada pooler.

encoder_ffn_dim (`int`, *opcional*, padrão `32`) : Dimensionalidade da camada "intermediária" (frequentemente chamada de feed-forward) no codificador.

decoder_ffn_dim (`int`, *opcional*, padrão `32`) : Dimensionalidade da camada "intermediária" (frequentemente chamada de feed-forward) no decodificador.

encoder_attention_heads (`int`, *opcional*, padrão `2`) : Número de cabeças de atenção para cada camada de atenção no codificador do Transformer.

decoder_attention_heads (`int`, *opcional*, padrão `2`) : Número de cabeças de atenção para cada camada de atenção no decodificador do Transformer.

encoder_layers (`int`, *opcional*, padrão `2`) : Número de camadas ocultas no codificador do Transformer. Usará o mesmo valor de `num_layers` se não for definido.

decoder_layers (`int`, *opcional*, padrão `2`) : Número de camadas ocultas no decodificador do Transformer. Usará o mesmo valor de `num_layers` se não for definido.

activation_function (`str`, *opcional*, padrão `gelu`) : A função de ativação não linear (função ou string) no decodificador. Por exemplo, `"gelu"`, `"relu"`, `"silu"`, etc.

dropout (`Union[float, int]`, *opcional*, padrão `0.05`) : A proporção para todas as camadas de dropout.

encoder_layerdrop (`Union[float, int]`, *opcional*, padrão `0.1`) : A probabilidade de LayerDrop para o codificador. Consulte o [artigo do LayerDrop](see https://huggingface.co/papers/1909.11556) para mais detalhes.

decoder_layerdrop (`Union[float, int]`, *opcional*, padrão `0.1`) : A probabilidade de LayerDrop para o decodificador. Consulte o [artigo do LayerDrop](see https://huggingface.co/papers/1909.11556) para mais detalhes.

attention_dropout (`Union[float, int]`, *opcional*, padrão `0.1`) : A taxa de dropout para as probabilidades de atenção.

activation_dropout (`float`, *opcional*, padrão 0.1) : A probabilidade de dropout usada entre as duas camadas das redes feed-forward.

num_parallel_samples (`int`, *opcional*, padrão 100) : O número de amostras a serem geradas em paralelo para cada passo de tempo da inferência.

init_std (`float`, *opcional*, padrão `0.02`) : O desvio padrão do truncated_normal_initializer para inicializar todas as matrizes de pesos.

use_cache (`bool`, *opcional*, padrão `True`) : Indica se o modelo deve retornar as últimas atenções de chave/valor (não utilizado por todos os modelos). Relevante apenas se `config.is_decoder=True` ou quando o modelo for um modelo generativo somente de decodificador.

attention_type (`str`, *opcional*, padrão "prob") : Atenção usada no codificador. Isso pode ser definido como "prob" (ProbAttention do Informer) ou "full" (autoatenção canônica do transformer vanilla).

sampling_factor (`int`, *opcional*, padrão 5) : Fator de amostragem ProbSparse (tem efeito apenas quando `attention_type`="prob"). É usado para controlar o comprimento de entrada da matriz de consulta reduzida (Q_reduce).

distil (`bool`, *opcional*, padrão `True`) : Se deve usar destilação no codificador.

Esta é a classe de configuração para armazenar a configuração de um InformerModel. Ela é usada para instanciar um modelo Informer de acordo com os argumentos especificados, definindo a arquitetura do modelo. Instanciar uma configuração com os padrões resultará em uma configuração semelhante à do [huggingface/informer-tourism-monthly](https://huggingface.co/huggingface/informer-tourism-monthly)

Os objetos de configuração herdam de [PreTrainedConfig](/docs/transformers/main/pt/main_classes/configuration#transformers.PreTrainedConfig) e podem ser usados para controlar as saídas do modelo. Leia a documentação de [PreTrainedConfig](/docs/transformers/main/pt/main_classes/configuration#transformers.PreTrainedConfig) para mais informações.

Exemplo:

```python
>>> from transformers import InformerConfig, InformerModel

>>> # Initializing an Informer configuration with 12 time steps for prediction
>>> configuration = InformerConfig(prediction_length=12)

>>> # Randomly initializing a model (with random weights) from the configuration
>>> model = InformerModel(configuration)

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

## InformerModel[[transformers.InformerModel]]

#### transformers.InformerModel[[transformers.InformerModel]]

```python
transformers.InformerModel(config: InformerConfig)
```

[Origem](https://github.com/huggingface/transformers/blob/main/src/transformers/models/informer/modeling_informer.py#L994)

**Parâmetros:**

config ([InformerConfig](/docs/transformers/main/pt/model_doc/informer#transformers.InformerConfig)) : Classe de configuração do modelo com todos os parâmetros do modelo. A inicialização com um arquivo de configuração não carrega os pesos associados ao modelo, apenas a configuração. Consulte o método [from_pretrained()](/docs/transformers/main/pt/main_classes/model#transformers.PreTrainedModel.from_pretrained) para carregar os pesos do modelo.

O modelo Informer básico, que produz estados ocultos brutos sem nenhum cabeçalho específico no topo.

Este modelo herda de [PreTrainedModel](/docs/transformers/main/pt/main_classes/model#transformers.PreTrainedModel). Consulte a documentação da classe pai para os métodos genéricos que a biblioteca implementa para todos os seus modelos (como download ou salvamento, redimensionamento dos embeddings de entrada, poda de cabeças, etc.).

Este modelo também é uma subclasse de [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module) do PyTorch. Use-o como um Módulo PyTorch regular e consulte a documentação do PyTorch para todos os assuntos relacionados ao uso e comportamento gerais.

#### forward[[transformers.InformerModel.forward]]

```python
forward(past_values: Tensor, past_time_features: Tensor, past_observed_mask: Tensor, static_categorical_features: typing.Optional[torch.Tensor] = None, static_real_features: typing.Optional[torch.Tensor] = None, future_values: typing.Optional[torch.Tensor] = None, future_time_features: typing.Optional[torch.Tensor] = None, decoder_attention_mask: typing.Optional[torch.LongTensor] = None, encoder_outputs: list[torch.Tensor] | None = None, past_key_values: transformers.cache_utils.Cache | None = None, use_cache: bool | None = None, **kwargs: *<class 'transformers.utils.generic.TransformersKwargs'>)
```

[Origem](https://github.com/huggingface/transformers/blob/main/src/transformers/models/informer/modeling_informer.py#L1132)

**Parâmetros:**

past_values (`torch.Tensor` de forma `(batch_size, sequence_length)` ou `(batch_size, sequence_length, input_size)`) : Valores passados da série temporal, que servem como contexto para prever o futuro. O tamanho da sequência deste tensor deve ser maior que o `context_length` do modelo, pois o modelo usará o tamanho maior para construir recursos de defasagem (lags), ou seja, valores adicionais do passado que são incluídos para servir como “contexto extra”. O `sequence_length` aqui é igual a `config.context_length` + `max(config.lags_sequence)`, o que, se nenhum `lags_sequence` estiver configurado, é igual a `config.context_length` + 7 (pois, por padrão, o maior índice de retrospectiva em `config.lags_sequence` é 7). A propriedade `_past_length` retorna o comprimento real do passado. O `past_values` é o que o codificador do Transformer recebe como entrada (com recursos adicionais opcionais, como `static_categorical_features`, `static_real_features`, `past_time_features` e defasagens). Opcionalmente, valores ausentes precisam ser substituídos por zeros e indicados via `past_observed_mask`. Para séries temporais multivariadas, a dimensão `input_size` > 1 é necessária e corresponde ao número de variáveis na série temporal por passo de tempo.

past_time_features (`torch.Tensor` de forma `(batch_size, sequence_length, num_features)`) : Recursos temporais obrigatórios, que o modelo adicionará internamente a `past_values`. Esses recursos podem ser coisas como "mês do ano", "dia do mês", etc., codificados como vetores (por exemplo, como recursos de Fourier). Também podem ser os chamados recursos de "idade", que basicamente ajudam o modelo a saber "em que ponto da vida" uma série temporal se encontra. Os recursos de idade têm valores pequenos para passos de tempo distantes no passado e aumentam monotonicamente à medida que nos aproximamos do passo de tempo atual. Recursos de feriados também são um bom exemplo de recursos temporais. Esses recursos servem como as "codificações posicionais" das entradas. Portanto, ao contrário de um modelo como BERT, onde as codificações de posição são aprendidas do zero internamente como parâmetros do modelo, o Time Series Transformer requer a provisão de recursos temporais adicionais. O Time Series Transformer apenas aprende incorporações adicionais para `static_categorical_features`. Covariáveis dinâmicas reais adicionais podem ser concatenadas a este tensor, com a ressalva de que esses recursos devem ser conhecidos no momento da previsão. O `num_features` aqui é igual a `config.`num_time_features` + `config.num_dynamic_real_features`.

past_observed_mask (`torch.BoolTensor` de forma `(batch_size, sequence_length)` ou `(batch_size, sequence_length, input_size)`, *opcional*) : Máscara booleana para indicar quais `past_values` foram observados e quais estavam ausentes. Valores da máscara selecionados em `[0, 1]`:  - 1 para valores que são **observados**, - 0 para valores que estão **ausentes** (ou seja, NaNs que foram substituídos por zeros).

static_categorical_features (`torch.LongTensor` de forma `(batch_size, number of static categorical features)`, *opcional*) : Características categóricas estáticas opcionais para as quais o modelo aprenderá um embedding, que será adicionado aos valores da série temporal. Características categóricas estáticas são aquelas que possuem o mesmo valor para todos os passos de tempo (estáticas ao longo do tempo). Um exemplo típico de uma característica categórica estática é um ID de série temporal.

static_real_features (`torch.Tensor` de forma `(batch_size, number of static real features)`, *opcional*) : Recursos estáticos reais opcionais que o modelo adicionará aos valores da série temporal.  Recursos estáticos reais são recursos que possuem o mesmo valor para todos os passos de tempo (estáticos ao longo do tempo).  Um exemplo típico de recurso estático real é a informação de promoção.

future_values (`torch.Tensor` de forma `(batch_size, prediction_length)` ou `(batch_size, prediction_length, input_size)`, *opcional*) : Valores futuros da série temporal, que servem como rótulos para o modelo. O `future_values` é o que o Transformer precisa durante o treinamento para aprender a produzir, dado o `past_values`. O comprimento da sequência aqui é igual a `prediction_length`. Consulte o notebook de demonstração e os trechos de código para mais detalhes. Opcionalmente, durante o treinamento, quaisquer valores ausentes precisam ser substituídos por zeros e indicados via `future_observed_mask`. Para séries temporais multivariadas, a dimensão `input_size` > 1 é necessária e corresponde ao número de variáveis na série temporal por passo de tempo.

future_time_features (`torch.Tensor` de forma `(batch_size, prediction_length, num_features)`) : Recursos temporais obrigatórios para a janela de previsão, que o modelo adicionará internamente a `future_values`. Esses recursos podem ser coisas como "mês do ano", "dia do mês", etc., codificados como vetores (por exemplo, como recursos de Fourier). Também podem ser os chamados recursos de "idade", que basicamente ajudam o modelo a saber "em que ponto da vida" uma série temporal se encontra. Os recursos de idade têm valores pequenos para passos de tempo distantes no passado e aumentam monotonicamente à medida que nos aproximamos do passo de tempo atual. Recursos de feriados também são um bom exemplo de recursos temporais. Esses recursos servem como as "codificações posicionais" das entradas. Portanto, ao contrário de um modelo como BERT, onde as codificações de posição são aprendidas do zero internamente como parâmetros do modelo, o Time Series Transformer requer a provisão de recursos temporais adicionais. O Time Series Transformer apenas aprende incorporações adicionais para `static_categorical_features`. Covariáveis dinâmicas reais adicionais podem ser concatenadas a este tensor, com a ressalva de que esses recursos devem ser conhecidos no momento da previsão. O `num_features` aqui é igual a `config.num_time_features` + `config.num_dynamic_real_features`.

decoder_attention_mask (`torch.LongTensor` de forma `(batch_size, target_sequence_length)`, *opcional*) : Máscara para evitar a execução de atenção em determinados índices de tokens. Por padrão, uma máscara causal será usada, para garantir que o modelo só possa olhar para entradas anteriores a fim de prever o futuro.

encoder_outputs (`tuple(tuple(torch.Tensor)`, *opcional*) : A tupla consiste em `last_hidden_state`, `hidden_states` (*opcional*) e `attentions` (*opcional*) `last_hidden_state` de forma `(batch_size, sequence_length, hidden_size)` (*opcional*) é uma sequência de estados ocultos na saída da última camada do codificador. Usado na atenção cruzada do decodificador.

past_key_values (`~cache_utils.Cache`, *opcional*) : hidden-states pré-computados (chaves e valores nos blocos de autoatenção e nos blocos de atenção cruzada) que podem ser usados para acelerar a decodificação sequencial. Isso geralmente consiste nos `past_key_values` retornados pelo modelo em uma etapa anterior da decodificação, quando `use_cache=True` ou `config.use_cache=True`.  Apenas uma instância de [Cache](/docs/transformers/main/pt/internal/generation_utils#transformers.Cache) é permitida como entrada, consulte nosso [guia de kv cache](https://huggingface.co/docs/transformers/en/kv_cache). Se nenhum `past_key_values` for passado, [DynamicCache](/docs/transformers/main/pt/internal/generation_utils#transformers.DynamicCache) será inicializado por padrão.  O modelo sairá no mesmo formato de cache que foi fornecido como entrada.  Se `past_key_values` forem usados, espera-se que o usuário insira apenas `input_ids` não processados (aqueles que não têm seus estados de chave e valor passados para este modelo) com a forma `(batch_size, unprocessed_length)` em vez de todos os `input_ids` com a forma `(batch_size, sequence_length)`.

use_cache (`bool`, *opcional*) : Se definido como `True`, os estados de chave-valor de `past_key_values` são retornados e podem ser usados para acelerar a decodificação (veja `past_key_values`).

**Retorna:** [Seq2SeqTSModelOutput](/docs/transformers/main/pt/main_classes/output#transformers.modeling_outputs.Seq2SeqTSModelOutput) ou `tuple(torch.Tensor)`

Um [Seq2SeqTSModelOutput](/docs/transformers/main/pt/main_classes/output#transformers.modeling_outputs.Seq2SeqTSModelOutput) ou uma tupla de `torch.Tensor` (se `return_dict=False` for passado ou quando `config.return_dict=False`) contendo vários elementos dependendo da configuração ([InformerConfig](/docs/transformers/main/pt/model_doc/informer#transformers.InformerConfig)) e das entradas.

O método forward do [InformerModel](/docs/transformers/main/pt/model_doc/informer#transformers.InformerModel) sobrescreve o método especial `__call__`.

Embora a receita para a passagem direta precise ser definida dentro desta função, deve-se chamar a instância de `Module` em seguida, em vez desta, pois a primeira cuida da execução das etapas de pré e pós-processamento, enquanto a segunda as ignora silenciosamente.

- **last_hidden_state** (`torch.Tensor` de forma `(batch_size, sequence_length, hidden_size)`) -- Sequência de estados ocultos na saída da última camada do decoder do modelo.

  Se `past_key_values` for usado, apenas o último hidden-state das sequências, com forma `(batch_size, 1, hidden_size)`, é retornado.
- **past_key_values** (`EncoderDecoderCache`, *opcional*, retornado quando `use_cache=True` é passado ou quando `config.use_cache=True`) -- É uma instância de [EncoderDecoderCache](/docs/transformers/main/pt/internal/generation_utils#transformers.EncoderDecoderCache). Para mais detalhes, consulte nosso [guia de cache kv](https://huggingface.co/docs/transformers/en/kv_cache).

  Contém estados ocultos pré-computados (chaves e valores nos blocos de autoatenção e nos blocos de atenção cruzada) que podem ser usados (veja a entrada `past_key_values`) para acelerar a decodificação sequencial.
- **decoder_hidden_states** (`tuple(torch.Tensor)`, *opcional*, retornado quando `output_hidden_states=True` é passado ou quando `config.output_hidden_states=True`) -- Tupla de `torch.Tensor` (uma para a saída dos embeddings, se o modelo tiver uma camada de embedding, + uma para a saída de cada camada) de forma `(batch_size, sequence_length, hidden_size)`.

  Estados ocultos do decodificador na saída de cada camada, além das saídas opcionais do embedding inicial.
- **decoder_attentions** (`tuple(torch.Tensor)`, *opcional*, retornado quando `output_attentions=True` é passado ou quando `config.output_attentions=True`) -- Tupla de `torch.Tensor` (uma para cada camada) com forma `(batch_size, num_heads, sequence_length, sequence_length)`.

  Pesos de atenção do decodificador, após o softmax de atenção, usados para calcular a média ponderada nas cabeças de autoatenção.
- **cross_attentions** (`tuple(torch.Tensor)`, *opcional*, retornado quando `output_attentions=True` é passado ou quando `config.output_attentions=True`) -- Tupla de `torch.Tensor` (uma para cada camada) de forma `(batch_size, num_heads, sequence_length, sequence_length)`.

  Pesos de atenção da camada de atenção cruzada do decodificador, após o softmax de atenção, usados para calcular a média ponderada nas cabeças de atenção cruzada.
- **encoder_last_hidden_state** (`torch.Tensor` de forma `(batch_size, sequence_length, hidden_size)`, *opcional*) -- Sequência de estados ocultos na saída da última camada do encoder do modelo.
- **encoder_hidden_states** (`tuple(torch.Tensor)`, *opcional*, retornado quando `output_hidden_states=True` é passado ou quando `config.output_hidden_states=True`) -- Tupla de `torch.Tensor` (uma para a saída dos embeddings, se o modelo tiver uma camada de embedding, + uma para a saída de cada camada) de forma `(batch_size, sequence_length, hidden_size)`.

  Estados ocultos do codificador na saída de cada camada, além das saídas opcionais do embedding inicial.
- **encoder_attentions** (`tuple(torch.Tensor)`, *opcional*, retornado quando `output_attentions=True` é passado ou quando `config.output_attentions=True`) -- Tupla de `torch.Tensor` (uma para cada camada) de forma `(batch_size, num_heads, sequence_length, sequence_length)`.

  Pesos de atenção do codificador, após o softmax de atenção, usados para calcular a média ponderada nas cabeças de autoatenção.
- **loc** (`torch.Tensor` de forma `(batch_size,)` ou `(batch_size, input_size)`, *opcional*) -- Desloca os valores da janela de contexto de cada série temporal, o que é usado para fornecer ao modelo entradas da mesma magnitude e, em seguida, para desfazer o deslocamento e voltar à magnitude original.
- **scale** (`torch.Tensor` de forma `(batch_size,)` ou `(batch_size, input_size)`, *opcional*) -- Valores de escala da janela de contexto de cada série temporal, usados para fornecer ao modelo entradas da mesma magnitude e, em seguida, para reescalar de volta à magnitude original.
- **static_features** (`torch.Tensor` de forma `(batch_size, feature size)`, *opcional*) -- Recursos estáticos de cada série temporal em um lote que são copiados para as covariáveis no momento da inferência.

Exemplos:

```python
>>> from huggingface_hub import hf_hub_download
>>> import torch
>>> from transformers import InformerModel

>>> file = hf_hub_download(
...     repo_id="hf-internal-testing/tourism-monthly-batch", filename="train-batch.pt", repo_type="dataset"
... )
>>> batch = torch.load(file)

>>> model = InformerModel.from_pretrained("huggingface/informer-tourism-monthly")

>>> # during training, one provides both past and future values
>>> # as well as possible additional features
>>> outputs = model(
...     past_values=batch["past_values"],
...     past_time_features=batch["past_time_features"],
...     past_observed_mask=batch["past_observed_mask"],
...     static_categorical_features=batch["static_categorical_features"],
...     static_real_features=batch["static_real_features"],
...     future_values=batch["future_values"],
...     future_time_features=batch["future_time_features"],
... )

>>> last_hidden_state = outputs.last_hidden_state
```

## InformerForPrediction[[transformers.InformerForPrediction]]

#### transformers.InformerForPrediction[[transformers.InformerForPrediction]]

```python
transformers.InformerForPrediction(config: InformerConfig)
```

[Origem](https://github.com/huggingface/transformers/blob/main/src/transformers/models/informer/modeling_informer.py#L1357)

**Parâmetros:**

config ([InformerConfig](/docs/transformers/main/pt/model_doc/informer#transformers.InformerConfig)) : Classe de configuração do modelo com todos os parâmetros do modelo. A inicialização com um arquivo de configuração não carrega os pesos associados ao modelo, apenas a configuração. Consulte o método [from_pretrained()](/docs/transformers/main/pt/main_classes/model#transformers.PreTrainedModel.from_pretrained) para carregar os pesos do modelo.

O modelo Informer com uma cabeça de distribuição no topo para previsão de séries temporais.

Este modelo herda de [PreTrainedModel](/docs/transformers/main/pt/main_classes/model#transformers.PreTrainedModel). Consulte a documentação da classe pai para os métodos genéricos que a biblioteca implementa para todos os seus modelos (como download ou salvamento, redimensionamento dos embeddings de entrada, poda de cabeças, etc.).

Este modelo também é uma subclasse de [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#torch.nn.Module) do PyTorch. Use-o como um Módulo PyTorch regular e consulte a documentação do PyTorch para todos os assuntos relacionados ao uso e comportamento gerais.

#### forward[[transformers.InformerForPrediction.forward]]

```python
forward(past_values: Tensor, past_time_features: Tensor, past_observed_mask: Tensor, static_categorical_features: typing.Optional[torch.Tensor] = None, static_real_features: typing.Optional[torch.Tensor] = None, future_values: typing.Optional[torch.Tensor] = None, future_time_features: typing.Optional[torch.Tensor] = None, future_observed_mask: typing.Optional[torch.Tensor] = None, decoder_attention_mask: typing.Optional[torch.LongTensor] = None, encoder_outputs: list[torch.Tensor] | None = None, past_key_values: transformers.cache_utils.Cache | None = None, use_cache: bool | None = None, **kwargs: *<class 'transformers.utils.generic.TransformersKwargs'>)
```

[Origem](https://github.com/huggingface/transformers/blob/main/src/transformers/models/informer/modeling_informer.py#L1392)

**Parâmetros:**

past_values (`torch.Tensor` de forma `(batch_size, sequence_length)` ou `(batch_size, sequence_length, input_size)`) : Valores passados da série temporal, que servem como contexto para prever o futuro. O tamanho da sequência deste tensor deve ser maior que o `context_length` do modelo, pois o modelo usará o tamanho maior para construir recursos de defasagem (lags), ou seja, valores adicionais do passado que são incluídos para servir como “contexto extra”. O `sequence_length` aqui é igual a `config.context_length` + `max(config.lags_sequence)`, o que, se nenhum `lags_sequence` estiver configurado, é igual a `config.context_length` + 7 (pois, por padrão, o maior índice de retrospectiva em `config.lags_sequence` é 7). A propriedade `_past_length` retorna o comprimento real do passado. O `past_values` é o que o codificador do Transformer recebe como entrada (com recursos adicionais opcionais, como `static_categorical_features`, `static_real_features`, `past_time_features` e defasagens). Opcionalmente, valores ausentes precisam ser substituídos por zeros e indicados via `past_observed_mask`. Para séries temporais multivariadas, a dimensão `input_size` > 1 é necessária e corresponde ao número de variáveis na série temporal por passo de tempo.

past_time_features (`torch.Tensor` de forma `(batch_size, sequence_length, num_features)`) : Recursos temporais obrigatórios, que o modelo adicionará internamente a `past_values`. Esses recursos podem ser coisas como "mês do ano", "dia do mês", etc., codificados como vetores (por exemplo, como recursos de Fourier). Também podem ser os chamados recursos de "idade", que basicamente ajudam o modelo a saber "em que ponto da vida" uma série temporal se encontra. Os recursos de idade têm valores pequenos para passos de tempo distantes no passado e aumentam monotonicamente à medida que nos aproximamos do passo de tempo atual. Recursos de feriados também são um bom exemplo de recursos temporais. Esses recursos servem como as "codificações posicionais" das entradas. Portanto, ao contrário de um modelo como BERT, onde as codificações de posição são aprendidas do zero internamente como parâmetros do modelo, o Time Series Transformer requer a provisão de recursos temporais adicionais. O Time Series Transformer apenas aprende incorporações adicionais para `static_categorical_features`. Covariáveis dinâmicas reais adicionais podem ser concatenadas a este tensor, com a ressalva de que esses recursos devem ser conhecidos no momento da previsão. O `num_features` aqui é igual a `config.`num_time_features` + `config.num_dynamic_real_features`.

past_observed_mask (`torch.BoolTensor` de forma `(batch_size, sequence_length)` ou `(batch_size, sequence_length, input_size)`, *opcional*) : Máscara booleana para indicar quais `past_values` foram observados e quais estavam ausentes. Valores da máscara selecionados em `[0, 1]`:  - 1 para valores que são **observados**, - 0 para valores que estão **ausentes** (ou seja, NaNs que foram substituídos por zeros).

static_categorical_features (`torch.LongTensor` de forma `(batch_size, number of static categorical features)`, *opcional*) : Características categóricas estáticas opcionais para as quais o modelo aprenderá um embedding, que será adicionado aos valores da série temporal. Características categóricas estáticas são aquelas que possuem o mesmo valor para todos os passos de tempo (estáticas ao longo do tempo). Um exemplo típico de uma característica categórica estática é um ID de série temporal.

static_real_features (`torch.Tensor` de forma `(batch_size, number of static real features)`, *opcional*) : Recursos estáticos reais opcionais que o modelo adicionará aos valores da série temporal.  Recursos estáticos reais são recursos que possuem o mesmo valor para todos os passos de tempo (estáticos ao longo do tempo).  Um exemplo típico de recurso estático real é a informação de promoção.

future_values (`torch.Tensor` de forma `(batch_size, prediction_length)` ou `(batch_size, prediction_length, input_size)`, *opcional*) : Valores futuros da série temporal, que servem como rótulos para o modelo. O `future_values` é o que o Transformer precisa durante o treinamento para aprender a produzir, dado o `past_values`. O comprimento da sequência aqui é igual a `prediction_length`. Consulte o notebook de demonstração e os trechos de código para mais detalhes. Opcionalmente, durante o treinamento, quaisquer valores ausentes precisam ser substituídos por zeros e indicados via `future_observed_mask`. Para séries temporais multivariadas, a dimensão `input_size` > 1 é necessária e corresponde ao número de variáveis na série temporal por passo de tempo.

future_time_features (`torch.Tensor` de forma `(batch_size, prediction_length, num_features)`) : Recursos temporais obrigatórios para a janela de previsão, que o modelo adicionará internamente a `future_values`. Esses recursos podem ser coisas como "mês do ano", "dia do mês", etc., codificados como vetores (por exemplo, como recursos de Fourier). Também podem ser os chamados recursos de "idade", que basicamente ajudam o modelo a saber "em que ponto da vida" uma série temporal se encontra. Os recursos de idade têm valores pequenos para passos de tempo distantes no passado e aumentam monotonicamente à medida que nos aproximamos do passo de tempo atual. Recursos de feriados também são um bom exemplo de recursos temporais. Esses recursos servem como as "codificações posicionais" das entradas. Portanto, ao contrário de um modelo como BERT, onde as codificações de posição são aprendidas do zero internamente como parâmetros do modelo, o Time Series Transformer requer a provisão de recursos temporais adicionais. O Time Series Transformer apenas aprende incorporações adicionais para `static_categorical_features`. Covariáveis dinâmicas reais adicionais podem ser concatenadas a este tensor, com a ressalva de que esses recursos devem ser conhecidos no momento da previsão. O `num_features` aqui é igual a `config.num_time_features` + `config.num_dynamic_real_features`.

future_observed_mask (`torch.BoolTensor` de forma `(batch_size, sequence_length)` ou `(batch_size, sequence_length, input_size)`, *opcional*) : Máscara booleana para indicar quais `future_values` foram observados e quais estavam ausentes. Valores da máscara selecionados em `[0, 1]`:  - 1 para valores que são **observados**, - 0 para valores que estão **ausentes** (ou seja, NaNs que foram substituídos por zeros).  Esta máscara é usada para filtrar os valores ausentes no cálculo final da perda.

decoder_attention_mask (`torch.LongTensor` de forma `(batch_size, target_sequence_length)`, *opcional*) : Máscara para evitar a execução de atenção em determinados índices de tokens. Por padrão, uma máscara causal será usada, para garantir que o modelo só possa olhar para entradas anteriores a fim de prever o futuro.

encoder_outputs (`tuple(tuple(torch.Tensor)`, *opcional*) : A tupla consiste em `last_hidden_state`, `hidden_states` (*opcional*) e `attentions` (*opcional*) `last_hidden_state` de forma `(batch_size, sequence_length, hidden_size)` (*opcional*) é uma sequência de estados ocultos na saída da última camada do codificador. Usado na atenção cruzada do decodificador.

past_key_values (`~cache_utils.Cache`, *opcional*) : hidden-states pré-computados (chaves e valores nos blocos de autoatenção e nos blocos de atenção cruzada) que podem ser usados para acelerar a decodificação sequencial. Isso geralmente consiste nos `past_key_values` retornados pelo modelo em uma etapa anterior da decodificação, quando `use_cache=True` ou `config.use_cache=True`.  Apenas uma instância de [Cache](/docs/transformers/main/pt/internal/generation_utils#transformers.Cache) é permitida como entrada, consulte nosso [guia de kv cache](https://huggingface.co/docs/transformers/en/kv_cache). Se nenhum `past_key_values` for passado, [DynamicCache](/docs/transformers/main/pt/internal/generation_utils#transformers.DynamicCache) será inicializado por padrão.  O modelo sairá no mesmo formato de cache que foi fornecido como entrada.  Se `past_key_values` forem usados, espera-se que o usuário insira apenas `input_ids` não processados (aqueles que não têm seus estados de chave e valor passados para este modelo) com a forma `(batch_size, unprocessed_length)` em vez de todos os `input_ids` com a forma `(batch_size, sequence_length)`.

use_cache (`bool`, *opcional*) : Se definido como `True`, os estados de chave-valor de `past_key_values` são retornados e podem ser usados para acelerar a decodificação (veja `past_key_values`).

**Retorna:** [Seq2SeqTSModelOutput](/docs/transformers/main/pt/main_classes/output#transformers.modeling_outputs.Seq2SeqTSModelOutput) ou `tuple(torch.Tensor)`

Um [Seq2SeqTSModelOutput](/docs/transformers/main/pt/main_classes/output#transformers.modeling_outputs.Seq2SeqTSModelOutput) ou uma tupla de `torch.Tensor` (se `return_dict=False` for passado ou quando `config.return_dict=False`) contendo vários elementos dependendo da configuração ([InformerConfig](/docs/transformers/main/pt/model_doc/informer#transformers.InformerConfig)) e das entradas.

O método forward da [InformerForPrediction](/docs/transformers/main/pt/model_doc/informer#transformers.InformerForPrediction) sobrescreve o método especial `__call__`.

Embora a receita para a passagem direta precise ser definida dentro desta função, deve-se chamar a instância de `Module` em seguida, em vez desta, pois a primeira cuida da execução das etapas de pré e pós-processamento, enquanto a segunda as ignora silenciosamente.

- **last_hidden_state** (`torch.Tensor` de forma `(batch_size, sequence_length, hidden_size)`) -- Sequência de estados ocultos na saída da última camada do decoder do modelo.

  Se `past_key_values` for usado, apenas o último hidden-state das sequências, com forma `(batch_size, 1, hidden_size)`, é retornado.
- **past_key_values** (`EncoderDecoderCache`, *opcional*, retornado quando `use_cache=True` é passado ou quando `config.use_cache=True`) -- É uma instância de [EncoderDecoderCache](/docs/transformers/main/pt/internal/generation_utils#transformers.EncoderDecoderCache). Para mais detalhes, consulte nosso [guia de cache kv](https://huggingface.co/docs/transformers/en/kv_cache).

  Contém estados ocultos pré-computados (chaves e valores nos blocos de autoatenção e nos blocos de atenção cruzada) que podem ser usados (veja a entrada `past_key_values`) para acelerar a decodificação sequencial.
- **decoder_hidden_states** (`tuple(torch.Tensor)`, *opcional*, retornado quando `output_hidden_states=True` é passado ou quando `config.output_hidden_states=True`) -- Tupla de `torch.Tensor` (uma para a saída dos embeddings, se o modelo tiver uma camada de embedding, + uma para a saída de cada camada) de forma `(batch_size, sequence_length, hidden_size)`.

  Estados ocultos do decodificador na saída de cada camada, além das saídas opcionais do embedding inicial.
- **decoder_attentions** (`tuple(torch.Tensor)`, *opcional*, retornado quando `output_attentions=True` é passado ou quando `config.output_attentions=True`) -- Tupla de `torch.Tensor` (uma para cada camada) com forma `(batch_size, num_heads, sequence_length, sequence_length)`.

  Pesos de atenção do decodificador, após o softmax de atenção, usados para calcular a média ponderada nas cabeças de autoatenção.
- **cross_attentions** (`tuple(torch.Tensor)`, *opcional*, retornado quando `output_attentions=True` é passado ou quando `config.output_attentions=True`) -- Tupla de `torch.Tensor` (uma para cada camada) de forma `(batch_size, num_heads, sequence_length, sequence_length)`.

  Pesos de atenção da camada de atenção cruzada do decodificador, após o softmax de atenção, usados para calcular a média ponderada nas cabeças de atenção cruzada.
- **encoder_last_hidden_state** (`torch.Tensor` de forma `(batch_size, sequence_length, hidden_size)`, *opcional*) -- Sequência de estados ocultos na saída da última camada do encoder do modelo.
- **encoder_hidden_states** (`tuple(torch.Tensor)`, *opcional*, retornado quando `output_hidden_states=True` é passado ou quando `config.output_hidden_states=True`) -- Tupla de `torch.Tensor` (uma para a saída dos embeddings, se o modelo tiver uma camada de embedding, + uma para a saída de cada camada) de forma `(batch_size, sequence_length, hidden_size)`.

  Estados ocultos do codificador na saída de cada camada, além das saídas opcionais do embedding inicial.
- **encoder_attentions** (`tuple(torch.Tensor)`, *opcional*, retornado quando `output_attentions=True` é passado ou quando `config.output_attentions=True`) -- Tupla de `torch.Tensor` (uma para cada camada) de forma `(batch_size, num_heads, sequence_length, sequence_length)`.

  Pesos de atenção do codificador, após o softmax de atenção, usados para calcular a média ponderada nas cabeças de autoatenção.
- **loc** (`torch.Tensor` de forma `(batch_size,)` ou `(batch_size, input_size)`, *opcional*) -- Desloca os valores da janela de contexto de cada série temporal, o que é usado para fornecer ao modelo entradas da mesma magnitude e, em seguida, para desfazer o deslocamento e voltar à magnitude original.
- **scale** (`torch.Tensor` de forma `(batch_size,)` ou `(batch_size, input_size)`, *opcional*) -- Valores de escala da janela de contexto de cada série temporal, usados para fornecer ao modelo entradas da mesma magnitude e, em seguida, para reescalar de volta à magnitude original.
- **static_features** (`torch.Tensor` de forma `(batch_size, feature size)`, *opcional*) -- Recursos estáticos de cada série temporal em um lote que são copiados para as covariáveis no momento da inferência.

Exemplos:

```python
>>> from huggingface_hub import hf_hub_download
>>> import torch
>>> from transformers import InformerForPrediction

>>> file = hf_hub_download(
...     repo_id="hf-internal-testing/tourism-monthly-batch", filename="train-batch.pt", repo_type="dataset"
... )
>>> batch = torch.load(file)

>>> model = InformerForPrediction.from_pretrained(
...     "huggingface/informer-tourism-monthly"
... )

>>> # during training, one provides both past and future values
>>> # as well as possible additional features
>>> outputs = model(
...     past_values=batch["past_values"],
...     past_time_features=batch["past_time_features"],
...     past_observed_mask=batch["past_observed_mask"],
...     static_categorical_features=batch["static_categorical_features"],
...     static_real_features=batch["static_real_features"],
...     future_values=batch["future_values"],
...     future_time_features=batch["future_time_features"],
... )

>>> loss = outputs.loss
>>> loss.backward()

>>> # during inference, one only provides past values
>>> # as well as possible additional features
>>> # the model autoregressively generates future values
>>> outputs = model.generate(
...     past_values=batch["past_values"],
...     past_time_features=batch["past_time_features"],
...     past_observed_mask=batch["past_observed_mask"],
...     static_categorical_features=batch["static_categorical_features"],
...     static_real_features=batch["static_real_features"],
...     future_time_features=batch["future_time_features"],
... )

>>> mean_prediction = outputs.sequences.mean(dim=1)
```