π Installation β’ π Features β’ π Usage Example β’ π Webapp β’ π Documentation β’ π License
Sinapsis Darts Forecasting provides a powerful and flexible implementation for time series forecasting using the Darts library.
Install using your package manager of choice. We encourage the use of uv
Example with uv
:
uv pip install sinapsis-darts-forecasting --extra-index-url https://pypi.sinapsis.tech
or with raw pip
:
pip install sinapsis-darts-forecasting --extra-index-url https://pypi.sinapsis.tech
The Sinapsis Darts Forecasting provides a powerful and flexible implementation for time series forecasting using the Darts library.
TimeSeriesDataframeLoader
The following attributes apply to TimeSeriesDataframeLoader template:
apply_to
(list, required): Specifies which attribute inTimeSeriesPacket
should be converted from Pandas DataFrame to Darts TimeSeries (content, past_covariates, future_covariates, predictions).from_dataframe_kwargs
(dict[str, Any], optional): Additional arguments to pass toTimeSeries.from_dataframe()
.
Darts Transformers
The following attributes apply to all the preprocessing templates from Darts Transformers:
apply_to
(list, required): Specifies which attributes inTimeSeriesPacket
should be transformed (content, past_covariates, future_covariates, predictions).method
(Literal, required): Specifies the transformation method to apply.transform_kwargs
(dict[str, Any], optional): Additional keyword arguments for the selected transformation method.params_key
(str, optional): If provided, transformation parameters are stored/retrieved inTimeSeriesPacket.generic_data
.
Additional transformation-specific attributes can be dynamically assigned through the class initialization dictionary (*_init
attributes). These attributes correspond directly to the arguments used in Darts Transformers.
Darts Models
The following attribute apply only to templates from Darts Models:
forecast_horizon
(int, optional): Number of future time steps the model should predict. Defaults to10
. Additional transformation-specific attributes can be dynamically assigned through the class initialization dictionary (*_init
attributes). These attributes correspond directly to the arguments used in Darts Models. Typically used for hyperparameters directly assigned to the corresponding model.
Tip
Use CLI command sinapsis info --all-template-names
to show a list with all the available Template names installed with Sinapsis Image Transforms.
Tip
Use CLI command sinapsis info --example-template-config TEMPLATE_NAME
to produce an example Agent config for the Template specified in TEMPLATE_NAME.
For example, for TimeSeriesDataframeLoader use sinapsis info --example-template-config TimeSeriesDataframeLoader
to produce the following example config:
agent:
name: my_test_agent
templates:
- template_name: InputTemplate
class_name: InputTemplate
attributes: {}
- template_name: TimeSeriesDataframeLoader
class_name: TimeSeriesDataframeLoader
template_input: InputTemplate
attributes:
apply_to: 'content'
from_dataframe_kwargs: {}
Example config
agent:
name: XGBLSTMForecastingAgent
description: ''
templates:
- template_name: InputTemplate
class_name: InputTemplate
attributes: {}
- template_name: TimeSeriesDataframeLoader
class_name: TimeSeriesDataframeLoader
template_input: InputTemplate
attributes:
apply_to: ["content", "past_covariates", "future_covariates"]
from_dataframe_kwargs:
time_col: "Date"
fill_missing_dates: True
freq: "D"
- template_name: MissingValuesFiller
class_name: MissingValuesFillerWrapper
template_input: TimeSeriesDataframeLoader
attributes:
method: "transform"
missingvaluesfiller_init: {}
apply_to: ["content", "past_covariates", "future_covariates"]
transform_kwargs:
method: "linear"
- template_name: TimeSeries
class_name: XGBModelWrapper
template_input: MissingValuesFiller
attributes:
forecast_horizon: 100
xgbmodel_init:
lags: 30
lags_past_covariates: 30
output_chunk_length: 100
random_state: 42
n_estimators: 200
learning_rate: 0.1
max_depth: 6
Important
Attributes specified under the *_init
keys (e.g., missingvaluesfiller_init
, xgbmodel_init
) correspond directly to the Darts transformation or models parameters. Ensure that values are assigned correctly according to the official Darts documentation, as they affect the behavior and performance of the model or the data.
To run the config, use the CLI:
sinapsis run name_of_config.yml
The webapp provides an intuitive interface for data loading, preprocessing, and forecasting. The webapp supports CSV file uploads, visualization of historical data, and forecasting.
Note
Kaggle offers a variety of datasets for forecasting. In this-link from Kaggle, you can find a Bitcoin historical dataset. You can download it to use it in the app. Past and future covariates datasets are optional for the analysis.
Important
Note that if you use another dataset, you need to change the attributes of the TimeSeriesDataframeLoader
Important
To run the app you first need to clone this repository:
git clone git@github.com:Sinapsis-ai/sinapsis-time-series-forecasting.git
cd sinapsis-time-series-forecasting
Note
If you'd like to enable external app sharing in Gradio, export GRADIO_SHARE_APP=True
π³ Docker
IMPORTANT This docker image depends on the sinapsis-nvidia:base image. Please refer to the official sinapsis instructions to Build with Docker.
- Build the sinapsis-time-series-forecasting image:
docker compose -f docker/compose.yaml build
- Start the app container:
docker compose -f docker/compose_apps.yaml up sinapsis-darts-forecasting-gradio -d
- Check the status:
docker logs -f sinapsis-darts-forecasting-gradio
- The logs will display the URL to access the webapp, e.g.:
NOTE: The url can be different, check the output of logs
Running on local URL: http://127.0.0.1:7860
- To stop the app:
docker compose -f docker/compose_apps.yaml down
π» UV
To run the webapp using the uv
package manager, please:
- Create the virtual environment and sync the dependencies:
uv sync --frozen
- Install the wheel:
uv pip install sinapsis-time-series-forecasting[all] --extra-index-url https://pypi.sinapsis.tech
- Run the webapp:
uv run webapps/darts_time_series_gradio_app.py
- The terminal will display the URL to access the webapp, e.g.:
NOTE: The url can be different, check the output of the terminal
Running on local URL: http://127.0.0.1:7860
Documentation for this and other sinapsis packages is available on the sinapsis website
Tutorials for different projects within sinapsis are available at sinapsis tutorials page
This project is licensed under the AGPLv3 license, which encourages open collaboration and sharing. For more details, please refer to the LICENSE file.
For commercial use, please refer to our official Sinapsis website for information on obtaining a commercial license.