> ## Documentation Index
> Fetch the complete documentation index at: https://nixtla.io/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# About TimeGPT

> Learn about TimeGPT - the foundation model for time series.

> [!NOTE]
>
> TimeGPT is a production-ready generative pretrained transformer model specifically designed for time series forecasting. It accurately forecasts domains such as retail, electricity, finance, and IoT with minimal code. Below you'll find a high-level overview of its features, architecture, and practical examples.

**1. 1. Start Now**

> [card] [Activate Free Trial](https://www.nixtla.io/book-a-free-trial?utm_source=nixtla.io\&utm_campaign=/docs/introduction/about_timegpt)
>
> Begin exploring TimeGPT right away with a free trial.

> [card] [Quickstart Guide](https://nixtla.io/docs/forecasting/timegpt_quickstart.md)
>
> Follow step-by-step instructions to get TimeGPT running quickly.

**2. 2. Choose Your Interface**

You can access TimeGPT through:

* Self-hosted deployment on your infrastructure (recommended): [request enterprise access](https://www.nixtla.io/book-a-free-trial?utm_source=nixtla.io\&utm_campaign=/docs/introduction/about_timegpt) for more information
* Hosted APIs: start your [free trial](https://www.nixtla.io/book-a-free-trial?utm_source=nixtla.io\&utm_campaign=/docs/introduction/about_timegpt)
* Azure Studio (TimeGEN-1)

**3. 3. Forecast or Detect Anomalies**

Perform zero-shot inference out-of-the-box to forecast future values or detect anomalies. Fine-tune the model if you need more targeted performance.

> [!TIP]
>
> For detailed instructions and advanced configurations, visit our
> [Quickstart Guide](https://nixtla.io/docs/forecasting/timegpt_quickstart.md) and additional tutorials.

## Features and Capabilities

> [accordion] Zero-shot Inference
>
> **[Zero-shot Inference](https://nixtla.io/docs/forecasting/timegpt_quickstart.md)**:
> Generate forecasts and detect anomalies immediately without prior training. Quickly gain insights from your data.

> [accordion] Fine-tuning
>
> **[Fine-tuning](https://nixtla.io/docs/forecasting/fine-tuning/steps.md)**:
> Enhance prediction accuracy by training TimeGPT on your own datasets, tailoring it to your unique scenario.

> [accordion] API Access
>
> **[API Access](https://nixtla.io/docs/introduction/ways_to_get_access.md)**:
> Integrate forecasts into applications via a robust API. See [Ways to get access](https://nixtla.io/docs/introduction/ways_to_get_access.md) to get
> your API key.
> Easily deploy TimeGPT in your own infrastructure or with any cloud provider using [Docker](https://nixtla.io/docs/setup/docker.md) or our Python [wheel file](https://nixtla.io/docs/setup/python_wheel.md).
> Also accessible in [Azure Studio](https://nixtla.io/docs/setup/azureai.md) or through private deployment.

> [accordion] Add Exogenous Variables
>
> **[Add Exogenous Variables](https://nixtla.io/docs/forecasting/exogenous-variables/numeric_features.md)**:
> Incorporate external variables (e.g., events, prices) to improve forecast accuracy.

> [accordion] Multiple Series Forecasting
>
> **[Multiple Series Forecasting](https://nixtla.io/docs/forecasting/timegpt_quickstart.md)**:
> Predict multiple time series at once, improving workflow efficiency.

> [accordion] Specific Loss Function
>
> **[Specific Loss Function](https://nixtla.io/docs/forecasting/fine-tuning/custom_loss.md)**:
> Customize training with loss functions that match your performance objectives.

> [accordion] Cross-validation
>
> **[Cross-validation](https://nixtla.io/docs/forecasting/evaluation/cross_validation.md)**:
> Evaluate model reliability and generalization with built-in cross-validation.

> [accordion] Prediction Intervals
>
> **[Prediction Intervals](https://nixtla.io/docs/forecasting/probabilistic/prediction_intervals.md)**:
> Generate intervals to capture forecast uncertainty.

> [accordion] Irregular Timestamps
>
> **[Irregular Timestamps](https://nixtla.io/docs/forecasting/special-topics/irregular_timestamps.md)**:
> Process data with non-uniform timestamps directly, with no extra preprocessing.

> [accordion] Anomaly Detection
>
> **[Anomaly Detection](https://nixtla.io/docs/anomaly_detection/real-time/introduction.md)**:
> Identify anomalies automatically, integrating external features for improved precision.

> [!NOTE]
>
> Get started quickly with the
> [Quickstart guide](https://nixtla.io/docs/forecasting/timegpt_quickstart.md). Explore in-depth tutorials on TimeGPT capabilities and real-world applications.

## Architecture

![TimeGPT Architecture Overview](https://github.com/Nixtla/nixtla/blob/main/nbs/img/timegpt_archi.png?raw=true)

TimeGPT Architecture Overview

TimeGPT's architecture builds on the self-attention mechanism introduced in the original ["Attention is All You Need"](https://arxiv.org/abs/1706.03762) paper. Unlike typical large language models (LLMs), TimeGPT is independently trained on extensive time series datasets to minimize forecasting errors.

> [!NOTE]
>
> TimeGPT employs an encoder-decoder structure with residual connections, layer normalization, and a linear output layer to match the decoder outputs to forecast dimensions. The attention-based mechanisms help the model capture diverse historical patterns to create accurate future predictions.

The model processes input sequences from left to right, similar to how humans read sentences, and predicts future values (*"tokens"*) based on historical windows of time series data.

## Explore Examples and Use Cases

> [accordion] Quickstart & Setup
>
> Quickly set up your workflow using our
> [Quickstart Guide](https://nixtla.io/docs/forecasting/timegpt_quickstart.md)
> or learn to use the API by
> [setting up your API key](https://nixtla.io/docs/setup/setting_up_your_api_key.md).

> [accordion] Practical Topics
>
> * [Anomaly Detection](https://nixtla.io/docs/anomaly_detection/real-time/introduction.md)
>
> * Fine-tuning with
>   [custom loss functions](https://nixtla.io/docs/forecasting/fine-tuning/custom_loss.md)
>
> * Scaling workflows using
>   [Spark](https://nixtla.io/docs/forecasting/forecasting-at-scale/spark.md),
>   [Dask](https://nixtla.io/docs/forecasting/forecasting-at-scale/dask.md), or
>   [Ray](https://nixtla.io/docs/forecasting/forecasting-at-scale/ray.md)
>
> * Integrating
>   [exogenous variables](https://nixtla.io/docs/forecasting/exogenous-variables/numeric_features.md),
>   validation with
>   [cross-validation](https://nixtla.io/docs/forecasting/evaluation/cross_validation.md),
>   and estimating uncertainty via
>   [quantile forecasts](https://nixtla.io/docs/forecasting/probabilistic/quantiles.md)
>   or
>   [prediction intervals](https://nixtla.io/docs/forecasting/probabilistic/prediction_intervals.md).

> [accordion] Real-world Applications
>
> * [Web Traffic Forecasting](https://nixtla.io/docs/use_cases/forecasting_web_traffic.md)
>
> * [Bitcoin Price Prediction](https://nixtla.io/docs/use_cases/bitcoin_price_prediction.md)

> [!TIP]
>
> With TimeGPT, you can rapidly iterate from initial exploration to high-accuracy forecasting. Dive deeper into the comprehensive tutorials for more sophisticated workflows.
