about_timegpt.mdx 6.8 KB
Newer Older
bailuo's avatar
readme  
bailuo committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
---
title: "About TimeGPT"
description: "Learn about TimeGPT - the foundation model for time series."
icon: "brain"
---

<br />

<Info>
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.
</Info>

<br />

<Steps>
  <Step title="1. Start Now">
    <CardGroup>
      <Card title="Activate Free Trial" href="https://dashboard.nixtla.io/freetrial" description="Begin exploring TimeGPT right away with a free trial." />
      <Card title="Quickstart Guide" href="/forecasting/timegpt_quickstart" description="Follow step-by-step instructions to get TimeGPT running quickly." />
    </CardGroup>
  </Step>

  <Step title="2. Choose Your Interface">
    You can access TimeGPT through:

      - Self-hosted deployment on your infrastructure (recommended): [book a call](https://meetings.hubspot.com/cristian-challu/enterprise-contact-us?uuid=dc037f5a-d93b-4%5B…%5D90b-a611dd9460af&utm_source=github&utm_medium=pricing_page) for more information
      - Hosted APIs: start your [free trial](https://dashboard.nixtla.io/sign_in)
      - Azure Studio (TimeGEN-1)

  </Step>

  <Step title="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.
  </Step>
</Steps>

<Check>
For detailed instructions and advanced configurations, visit our
[Quickstart Guide](/forecasting/timegpt_quickstart) and additional tutorials.
</Check>

## Features and Capabilities

<AccordionGroup>
  <Accordion title="Zero-shot Inference">
    **[Zero-shot Inference](/forecasting/timegpt_quickstart)**:
    Generate forecasts and detect anomalies immediately without prior training. Quickly gain insights from your data.
  </Accordion>

  <Accordion title="Fine-tuning">
    **[Fine-tuning](/forecasting/fine-tuning/steps)**:
    Enhance prediction accuracy by training TimeGPT on your own datasets, tailoring it to your unique scenario.
  </Accordion>

  <Accordion title="API Access">
    **[API Access](https://dashboard.nixtla.io/sign_in)**:
    Integrate forecasts into applications via a robust API. Easily obtain keys at the
    [Dashboard](https://dashboard.nixtla.io/sign_in).
    Easily deploy TimeGPT in your own infrastructure or with any cloud provider using [Docker](/setup/docker) or our Python [wheel file](/setup/python_wheel).
    Also accessible in [Azure Studio](/setup/azureai) or through private deployment.
  </Accordion>

  <Accordion title="Add Exogenous Variables">
    **[Add Exogenous Variables](/forecasting/exogenous-variables/numeric_features)**:
    Incorporate external variables (e.g., events, prices) to improve forecast accuracy.
  </Accordion>

  <Accordion title="Multiple Series Forecasting">
    **[Multiple Series Forecasting](/forecasting/timegpt_quickstart)**:
    Predict multiple time series at once, improving workflow efficiency.
  </Accordion>

  <Accordion title="Specific Loss Function">
    **[Specific Loss Function](/forecasting/fine-tuning/custom_loss)**:
    Customize training with loss functions that match your performance objectives.
  </Accordion>

  <Accordion title="Cross-validation">
    **[Cross-validation](/forecasting/evaluation/cross_validation)**:
    Evaluate model reliability and generalization with built-in cross-validation.
  </Accordion>

  <Accordion title="Prediction Intervals">
    **[Prediction Intervals](/forecasting/probabilistic/prediction_intervals)**:
    Generate intervals to capture forecast uncertainty.
  </Accordion>

  <Accordion title="Irregular Timestamps">
    **[Irregular Timestamps](/forecasting/special-topics/irregular_timestamps)**:
    Process data with non-uniform timestamps directly, with no extra preprocessing.
  </Accordion>

  <Accordion title="Anomaly Detection">
    **[Anomaly Detection](/anomaly_detection/real-time/introduction)**:
    Identify anomalies automatically, integrating external features for improved precision.
  </Accordion>
</AccordionGroup>

<Info>
Get started quickly with the
[Quickstart guide](/forecasting/timegpt_quickstart). Explore in-depth tutorials on TimeGPT capabilities and real-world applications.
</Info>

## Architecture

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

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.

<Info>
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.
</Info>

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

<AccordionGroup>
  <Accordion title="Quickstart & Setup">
    Quickly set up your workflow using our
    [Quickstart Guide](/forecasting/timegpt_quickstart)
    or learn to use the API by
    [setting up your API key](/setup/setting_up_your_api_key).
  </Accordion>
  <Accordion title="Practical Topics">

      - [Anomaly Detection](/anomaly_detection/real-time/introduction)

      -
        Fine-tuning with
        [custom loss functions](/forecasting/fine-tuning/custom_loss)


      -
        Scaling workflows using
        [Spark](/forecasting/forecasting-at-scale/spark),
        [Dask](/forecasting/forecasting-at-scale/dask), or
        [Ray](/forecasting/forecasting-at-scale/ray)


      -
        Integrating
        [exogenous variables](/forecasting/exogenous-variables/numeric_features),
        validation with
        [cross-validation](/forecasting/evaluation/cross_validation),
        and estimating uncertainty via
        [quantile forecasts](/forecasting/probabilistic/quantiles)
        or
        [prediction intervals](/forecasting/probabilistic/prediction_intervals).



  </Accordion>
  <Accordion title="Real-world Applications">

      - [Web Traffic Forecasting](/use_cases/forecasting_web_traffic)

      - [Bitcoin Price Prediction](/use_cases/bitcoin_price_prediction)


  </Accordion>
</AccordionGroup>

<Check>
With TimeGPT, you can rapidly iterate from initial exploration to high-accuracy forecasting. Dive deeper into the comprehensive tutorials for more sophisticated workflows.
</Check>