TimesFM
Python template · sinapsis_timesfm.templates.timesfm
Overview
Template for time series forecasting using the TimesFM model.
Attributes: model_name (str): Hugging Face model identifier for TimesFM. Default: 'google/timesfm-2.5-200m-pytorch'. forecasting_config (ForecastConfigBM): Forecasting behavior configuration passed to TimesFM.compile(). Default: factory=ForecastConfigBM. forecast_horizon (int): Number of future steps to predict for each input series. Default: 12. validation_mode (bool): If true, reserve the last `forecast_horizon` points for validation. Default: False. device (str): Torch device used for inference, for example 'cpu' or 'cuda:0'. Default: 'cpu'. time_column_name (str): Name of the time column in dataframe content. Default: 'Date'. output_format (Literal['dataframe', 'darts_time_series']): Format of the output forecasts. 'dataframe' returns a pandas DataFrame, while 'darts_time_series' returns a Darts TimeSeries object. Default: 'darts_time_series'.
Capabilities
Capabilities: not setInstallation
Install the published package using pip or uv.
pip install sinapsis-timesfm==1.0.0uv pip install sinapsis-timesfm==1.0.0uv add sinapsis-timesfm==1.0.0Configuration
Effective fields from the inspector schema, including nested Pydantic model fields.
Torch device used for inference, for example 'cpu' or 'cuda:0'.
Optional
Default: "cpu"
Optional
Default: null
Hugging Face model identifier for TimesFM.
Optional
Default: "google/timesfm-2.5-200m-pytorch"
Format of the output forecasts. 'dataframe' returns a pandas DataFrame, while 'darts_time_series' returns a Darts TimeSeries object.
Optional
Default: "darts_time_series"
If true, reserve the last `forecast_horizon` points for validation.
Optional
Default: false
Number of future steps to predict for each input series.
Optional
Default: 12
Name of the time column in dataframe content.
Optional
Default: "Date"
Forecasting behavior configuration passed to TimesFM.compile().
Optional
Default: null
Optional
Default: 0
Optional
Default: 0
Optional
Default: 0
Optional
Default: false
Optional
Default: false
Optional
Default: true
Optional
Default: 1
Optional
Default: false
Optional
Default: true
Optional
Default: false
Configuration example
Generated from documented defaults. Replace any placeholders and complete required nested settings before running.
templates:
- template_name: "TimesFM"
class_name: "TimesFM"
attributes:
device: "cpu"
model_name: "google/timesfm-2.5-200m-pytorch"
output_format: "darts_time_series"
validation_mode: false
forecast_horizon: 12
time_column_name: "Date"
forecasting_config:
max_context: 0
max_horizon: 0
window_size: 0
return_backcast: false
normalize_inputs: false
infer_is_positive: true
per_core_batch_size: 1
fix_quantile_crossing: false
force_flip_invariance: true
use_continuous_quantile_head: false
Inheritance
sinapsis_core.template_base.template.TemplateEnvironment variables
Environment definitions belong to their canonical Python modules.
No directly related environment variables listed.