Skip to main content

source

NixtlaClient

Client to interact with the Nixtla API.
source

NixtlaClient.validate_api_key

Check API key status.
source

NixtlaClient.forecast

Forecast your time series using TimeGPT.
source

NixtlaClient.simulate

Generate temporally correlated forecast sample paths. The request runs as an asynchronous job on the server: the client submits it, then polls its status until it finishes, so the call blocks until the paths are available. Use async_job_wait_timeout and async_job_poll_interval on NixtlaClient to control the waiting behavior. A job that fails on the server raises nixtla.AsyncJobError; one that outlives async_job_wait_timeout is cancelled and raises TimeoutError. See Forecast Simulation for complete examples, output interpretation, limits, and scenario analysis.
source

NixtlaClient.explain

Compute model-independent historical feature importance weights. The request runs as an asynchronous job on the server: the client submits it, then polls its status until it finishes, so the call blocks until the weights are available. Use async_job_wait_timeout and async_job_poll_interval on NixtlaClient to control the waiting behavior. A job that fails on the server raises nixtla.AsyncJobError; one that outlives async_job_wait_timeout is cancelled and raises TimeoutError. The weights describe predictive relationships in historical data; they do not establish causality. See Find predictive signals in history for interpretation guidance and examples.
source

NixtlaClient.cross_validation

Perform cross validation in your time series using TimeGPT.
source

NixtlaClient.detect_anomalies

Detect anomalies in your time series using TimeGPT.
source

NixtlaClient.usage

Query consumed requests and limits
source

NixtlaClient.finetune

Fine-tune TimeGPT to your series.
source

NixtlaClient.finetuned_models

List fine-tuned models
source

NixtlaClient.finetuned_model

Get fine-tuned model metadata
source

NixtlaClient.delete_finetuned_model

Delete a previously fine-tuned model
source

NixtlaClient.plot

Plot forecasts and insample values.