Skip to main content

Time Series Forecasting Tool

Project description

TSFT — Time Series Forecasting Tool

Python Darts Dash

TSFT is a CLI utility for training deep learning forecasting models, generating exploratory reports, and visualizing results for time series data.

It is built on top of Darts + PyTorch Lightning and provides a simple command-line interface powered by Typer.

Features

  • Deep learning forecasting models (Darts-based)
  • Interactive Dash dashboards
  • Clean CLI interface

Installation

pip install tsft

Or install locally:

pip install -e .

Usage

tsft [COMMAND] [OPTIONS]

Available commands:

  • report — Launch exploratory dashboard for a dataset
  • run — Train a forecasting model
  • summary — Visualize training results

Generate Dataset Report

Launch an interactive dashboard for time series exploration:

tsft report data.csv

Optional:

tsft report data.csv --port 9000

Train a Model

Train a forecasting model on your dataset:

tsft run data.csv

With options:

tsft run data.csv \
  --model=nbeats \
  --input-chunk=24 \
  --output-chunk=12 \
  --epochs=5 \
  --no-stopper \
  --output=results/

Options

Option Description
--model Model name (lstm, gru, rnn, nbeats, transformer, tcn)
--input-chunk Input window length
--output-chunk Forecast horizon
--epochs Number of training epochs
--stopper / --no-stopper Enable/disable early stopping
--output Directory to save artifacts

View Training Results

Launch dashboard with training results:

tsft summary results/

Optional:

tsft summary results/ --port 9000

Example Workflow

# 1. Explore dataset
tsft report data.csv

# 2. Train model
tsft run data.csv --output=output_dir --model=nbeats --epochs=5 --input-chunk=30 --output-chunk=10 --no-stopper

# 3. View results
tsft summary outputs/

Dashboard Preview

Report Dashboard

Training Summary

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tsft-0.1.0.tar.gz (11.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tsft-0.1.0-py3-none-any.whl (16.6 kB view details)

Uploaded Python 3

File details

Details for the file tsft-0.1.0.tar.gz.

File metadata

  • Download URL: tsft-0.1.0.tar.gz
  • Upload date:
  • Size: 11.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.2 CPython/3.12.8 Windows/10

File hashes

Hashes for tsft-0.1.0.tar.gz
Algorithm Hash digest
SHA256 5d037870edf1d390b2071ccf6287e2efa48fc9021815da33b1b3528bb98091a3
MD5 b9e06b3e5bb8dc07621f2fede70dfb6e
BLAKE2b-256 ce33afbf74e22ed3d14aec5eee1e9bfb329748379c3eb0e76682ed5b31cb2884

See more details on using hashes here.

File details

Details for the file tsft-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: tsft-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 16.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.3.2 CPython/3.12.8 Windows/10

File hashes

Hashes for tsft-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 e258905a653490c3e7f32528e7b3d9216988b48bb686429c748ed866ebb70215
MD5 7b8ed741a5f8166ffbacc9ab3353af7f
BLAKE2b-256 146a41e6cdf66abe7c7c7346d413ca335ecdbf0b8829e0976b0ee3656b33183c

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page