Quickstart (TimeGPT-2)

​

TimeGPT-2 Family of Foundation Models

​

Set Up TimeGPT-2 family of models for Python Time Series Forecasting

​

Step 1: Confirm Access and get an API Key

• Confirm with support@nixtla.io that your account has access to these latest models.
• Get your API key from dashboard. Note that you can also use your existing keys as long as your account has access to these latest models (Step 1 above).
  • Sign in using Google, GitHub, or your email.
  • Navigate to API Keys in the menu and select Create New API Key.
  • Your new API key will appear on the screen. Copy this key and save it in a safe place for use later.

​

Step 2: Install Nixtla

pip install nixtla>=0.7.4

from nixtla import __version__
print(__version__)

0.7.4

​

Step 3: Import the Nixtla TimeGPT client

from nixtla import NixtlaClient

nixtla_client = NixtlaClient(
    base_url = 'https://api.nixtla.io',
    api_key='my_api_key_provided_by_nixtla'
)

nixtla_client.validate_api_key()

True

​

Forecasting with TimeGPT-2 family

​

Load your time series data

import pandas as pd

df = pd.read_csv('https://raw.githubusercontent.com/Nixtla/transfer-learning-time-series/main/datasets/air_passengers.csv')
df.head()

​

Generate the forecast

timegpt_fcst_df = nixtla_client.forecast(
    df,
    h=12,
    time_col="timestamp",
    target_col="value",
    model="timegpt-2.1",
)

​

Plot the forecast

nixtla_client.plot(df, timegpt_fcst_df, time_col='timestamp', target_col='value')

​

Summary

• Make sure that your account has access to these models
• Install the latest Nixtla client (>= 0.7.4)
• Make sure you use the right base_url while instantiating the client along with your API key.