<img src="https://raw.githubusercontent.com/daniel-om-weber/tsfast/refs/heads/master/assets/logo.svg" width="200" align="left" alt="tsfast logo">
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
## TSFast
[](https://badge.fury.io/py/tsfast)
[](https://opensource.org/licenses/Apache-2.0)
[](https://daniel-om-weber.github.io/tsfast/)
[](https://pypi.org/project/tsfast/)
## Description
> `tsfast` is an open-source deep learning library for time series
> analysis and system identification tasks. Built on PyTorch & fastai,
> it offers efficient deep learning models and utilities.
`tsfast` is an open-source deep learning package that focuses on system
identification and time series analysis tasks. Built on the foundations
of PyTorch and fastai, it provides efficient implementations of various
deep learning models and utilities.
## Key Features
- **Specialized Data Handling for Time Series**:
- Employs `SequenceBlock` (built on `fastai.TransformBlock`) for
robust sequence data processing pipelines.
- Includes a range of transforms tailored for sequences, such as
`SeqSlice`, `SeqNoiseInjection`, and `Normalize` adapted for time
series tensors.
- Features advanced data loading with `TbpttDl` (for Truncated
Backpropagation Through Time), and factories for `WeightedDL` and
`BatchLimitDL`.
- **Predefined Datasets & Helpers**: Offers easy-to-use benchmark
datasets (e.g., `create_dls_silverbox` from `identibench`) for rapid
prototyping and experimentation.
- **Tailored Time Series Models**: Provides implementations of Recurrent
Neural Networks (RNNs, including
[`DenseNet_RNN`](https://daniel-om-weber.github.io/tsfast/03_models/rnn.html#densenet_rnn),
[`ResidualBlock_RNN`](https://daniel-om-weber.github.io/tsfast/03_models/rnn.html#residualblock_rnn)),
Convolutional Neural Networks (TCNs,
[`CausalConv1d`](https://daniel-om-weber.github.io/tsfast/03_models/cnn.html#causalconv1d)),
and combined architectures
([`CRNN`](https://daniel-om-weber.github.io/tsfast/03_models/cnn.html#crnn),
[`SeperateCRNN`](https://daniel-om-weber.github.io/tsfast/03_models/cnn.html#seperatecrnn))
specifically designed for sequence modeling. Includes building blocks
like
[`SeqLinear`](https://daniel-om-weber.github.io/tsfast/03_models/layers.html#seqlinear)
and stateful batch normalization.
- **Integrated `fastai` Learner**: Features
[`RNNLearner`](https://daniel-om-weber.github.io/tsfast/02_learner/learner.html#rnnlearner),
[`TCNLearner`](https://daniel-om-weber.github.io/tsfast/02_learner/learner.html#tcnlearner),
[`CRNNLearner`](https://daniel-om-weber.github.io/tsfast/02_learner/learner.html#crnnlearner),
etc., extending `fastai`’s `Learner` for streamlined model training,
equipped with custom time-series losses (e.g.,
[`fun_rmse`](https://daniel-om-weber.github.io/tsfast/02_learner/losses.html#fun_rmse),
[`nrmse`](https://daniel-om-weber.github.io/tsfast/02_learner/losses.html#nrmse))
and callbacks (e.g.,
[`TbpttResetCB`](https://daniel-om-weber.github.io/tsfast/00_data/loader.html#tbpttresetcb),
[`ARInitCB`](https://daniel-om-weber.github.io/tsfast/02_learner/callbacks.html#arinitcb),
[`SkipFirstNCallback`](https://daniel-om-weber.github.io/tsfast/02_learner/callbacks.html#skipfirstncallback)).
- **System Identification & Prediction**:
- Supports simulation (prediction based on inputs) and N-step ahead
forecasting.
- Includes specialized models and callbacks for system identification
tasks like FRANSYS (`FranSys`, `FranSysCallback`) and AR models
(`AR_Model`, `ARProg`).
- Provides an `InferenceWrapper` for easier model deployment and
prediction.
- **Hyperparameter Optimization**: Integrates with Ray Tune via
[`HPOptimizer`](https://daniel-om-weber.github.io/tsfast/tune.html#hpoptimizer)
for efficient hyperparameter searching.
## Installation
You can install the **latest stable** version from pip using:
``` python
pip install tsfast
```
For development installation:
``` python
git clone https://github.com/daniel-om-weber/tsfast
cd tsfast
pip install -e '.[dev]'
```
## Quick Start
Here is a quick example using a benchmark dataloader. It demonstrates
loading and visualizing data, training a RNN, and visualizing the
results.
``` python
from tsfast.basics import *
dls = create_dls_silverbox()
dls.show_batch(max_n=1)
```
``` python
lrn = RNNLearner(dls)
lrn.fit_flat_cos(1)
```
<style>
/* Turns off some styling */
progress {
/* gets rid of default border in Firefox and Opera. */
border: none;
/* Needs to be in here for Safari polyfill so background images work as expected. */
background-size: auto;
}
progress:not([value]), progress:not([value])::-webkit-progress-bar {
background: repeating-linear-gradient(45deg, #7e7e7e, #7e7e7e 10px, #5c5c5c 10px, #5c5c5c 20px);
}
.progress-bar-interrupted, .progress-bar-interrupted::-webkit-progress-bar {
background: #F44336;
}
</style>
| epoch | train_loss | valid_loss | fun_rmse | time |
|-------|------------|------------|----------|-------|
| 0 | 0.006716 | 0.006925 | 0.015471 | 01:55 |
``` python
lrn.show_results(max_n=1)
```
<style>
/* Turns off some styling */
progress {
/* gets rid of default border in Firefox and Opera. */
border: none;
/* Needs to be in here for Safari polyfill so background images work as expected. */
background-size: auto;
}
progress:not([value]), progress:not([value])::-webkit-progress-bar {
background: repeating-linear-gradient(45deg, #7e7e7e, #7e7e7e 10px, #5c5c5c 10px, #5c5c5c 20px);
}
.progress-bar-interrupted, .progress-bar-interrupted::-webkit-progress-bar {
background: #F44336;
}
</style>
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
For major changes, please open an issue first to discuss what you would
like to change.
## Citation
If you use tsfast in your research, please cite:
``` text
@Misc{tsfast,
author = {Daniel O.M. Weber},
title = {tsfast - A deep learning library for time series analysis and system identification},
howpublished = {Github},
year = {2024},
url = {https://github.com/daniel-om-weber/tsfast}
}
```
Raw data
{
"_id": null,
"home_page": "https://github.com/daniel-om-weber/tsfast",
"name": "tsfast",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": "fastai time-series system-identification deep-learning pytorch fransys",
"author": "Daniel Oliver Martin Weber",
"author_email": "daniel.om.weber@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/81/9c/2dbfebaa53f7b83c3e7594522777796f22e35dae095d57c8086af032ad40/tsfast-0.1.5.tar.gz",
"platform": null,
"description": "\n\n<img src=\"https://raw.githubusercontent.com/daniel-om-weber/tsfast/refs/heads/master/assets/logo.svg\" width=\"200\" align=\"left\" alt=\"tsfast logo\">\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## TSFast\n\n[](https://badge.fury.io/py/tsfast)\n[](https://opensource.org/licenses/Apache-2.0)\n[](https://daniel-om-weber.github.io/tsfast/)\n[](https://pypi.org/project/tsfast/)\n\n## Description\n\n> `tsfast` is an open-source deep learning library for time series\n> analysis and system identification tasks. Built on PyTorch & fastai,\n> it offers efficient deep learning models and utilities.\n\n`tsfast` is an open-source deep learning package that focuses on system\nidentification and time series analysis tasks. Built on the foundations\nof PyTorch and fastai, it provides efficient implementations of various\ndeep learning models and utilities.\n\n## Key Features\n\n- **Specialized Data Handling for Time Series**:\n - Employs `SequenceBlock` (built on `fastai.TransformBlock`) for\n robust sequence data processing pipelines.\n - Includes a range of transforms tailored for sequences, such as\n `SeqSlice`, `SeqNoiseInjection`, and `Normalize` adapted for time\n series tensors.\n - Features advanced data loading with `TbpttDl` (for Truncated\n Backpropagation Through Time), and factories for `WeightedDL` and\n `BatchLimitDL`.\n- **Predefined Datasets & Helpers**: Offers easy-to-use benchmark\n datasets (e.g., `create_dls_silverbox` from `identibench`) for rapid\n prototyping and experimentation.\n- **Tailored Time Series Models**: Provides implementations of Recurrent\n Neural Networks (RNNs, including\n [`DenseNet_RNN`](https://daniel-om-weber.github.io/tsfast/03_models/rnn.html#densenet_rnn),\n [`ResidualBlock_RNN`](https://daniel-om-weber.github.io/tsfast/03_models/rnn.html#residualblock_rnn)),\n Convolutional Neural Networks (TCNs,\n [`CausalConv1d`](https://daniel-om-weber.github.io/tsfast/03_models/cnn.html#causalconv1d)),\n and combined architectures\n ([`CRNN`](https://daniel-om-weber.github.io/tsfast/03_models/cnn.html#crnn),\n [`SeperateCRNN`](https://daniel-om-weber.github.io/tsfast/03_models/cnn.html#seperatecrnn))\n specifically designed for sequence modeling. Includes building blocks\n like\n [`SeqLinear`](https://daniel-om-weber.github.io/tsfast/03_models/layers.html#seqlinear)\n and stateful batch normalization.\n- **Integrated `fastai` Learner**: Features\n [`RNNLearner`](https://daniel-om-weber.github.io/tsfast/02_learner/learner.html#rnnlearner),\n [`TCNLearner`](https://daniel-om-weber.github.io/tsfast/02_learner/learner.html#tcnlearner),\n [`CRNNLearner`](https://daniel-om-weber.github.io/tsfast/02_learner/learner.html#crnnlearner),\n etc., extending `fastai`\u2019s `Learner` for streamlined model training,\n equipped with custom time-series losses (e.g.,\n [`fun_rmse`](https://daniel-om-weber.github.io/tsfast/02_learner/losses.html#fun_rmse),\n [`nrmse`](https://daniel-om-weber.github.io/tsfast/02_learner/losses.html#nrmse))\n and callbacks (e.g.,\n [`TbpttResetCB`](https://daniel-om-weber.github.io/tsfast/00_data/loader.html#tbpttresetcb),\n [`ARInitCB`](https://daniel-om-weber.github.io/tsfast/02_learner/callbacks.html#arinitcb),\n [`SkipFirstNCallback`](https://daniel-om-weber.github.io/tsfast/02_learner/callbacks.html#skipfirstncallback)).\n- **System Identification & Prediction**:\n - Supports simulation (prediction based on inputs) and N-step ahead\n forecasting.\n - Includes specialized models and callbacks for system identification\n tasks like FRANSYS (`FranSys`, `FranSysCallback`) and AR models\n (`AR_Model`, `ARProg`).\n - Provides an `InferenceWrapper` for easier model deployment and\n prediction.\n- **Hyperparameter Optimization**: Integrates with Ray Tune via\n [`HPOptimizer`](https://daniel-om-weber.github.io/tsfast/tune.html#hpoptimizer)\n for efficient hyperparameter searching.\n\n## Installation\n\nYou can install the **latest stable** version from pip using:\n\n``` python\npip install tsfast\n```\n\nFor development installation:\n\n``` python\ngit clone https://github.com/daniel-om-weber/tsfast\ncd tsfast\npip install -e '.[dev]'\n```\n\n## Quick Start\n\nHere is a quick example using a benchmark dataloader. It demonstrates\nloading and visualizing data, training a RNN, and visualizing the\nresults.\n\n``` python\nfrom tsfast.basics import *\ndls = create_dls_silverbox()\ndls.show_batch(max_n=1)\n```\n\n\n\n``` python\nlrn = RNNLearner(dls)\nlrn.fit_flat_cos(1)\n```\n\n<style>\n /* Turns off some styling */\n progress {\n /* gets rid of default border in Firefox and Opera. */\n border: none;\n /* Needs to be in here for Safari polyfill so background images work as expected. */\n background-size: auto;\n }\n progress:not([value]), progress:not([value])::-webkit-progress-bar {\n background: repeating-linear-gradient(45deg, #7e7e7e, #7e7e7e 10px, #5c5c5c 10px, #5c5c5c 20px);\n }\n .progress-bar-interrupted, .progress-bar-interrupted::-webkit-progress-bar {\n background: #F44336;\n }\n</style>\n\n| epoch | train_loss | valid_loss | fun_rmse | time |\n|-------|------------|------------|----------|-------|\n| 0 | 0.006716 | 0.006925 | 0.015471 | 01:55 |\n\n``` python\nlrn.show_results(max_n=1)\n```\n\n<style>\n /* Turns off some styling */\n progress {\n /* gets rid of default border in Firefox and Opera. */\n border: none;\n /* Needs to be in here for Safari polyfill so background images work as expected. */\n background-size: auto;\n }\n progress:not([value]), progress:not([value])::-webkit-progress-bar {\n background: repeating-linear-gradient(45deg, #7e7e7e, #7e7e7e 10px, #5c5c5c 10px, #5c5c5c 20px);\n }\n .progress-bar-interrupted, .progress-bar-interrupted::-webkit-progress-bar {\n background: #F44336;\n }\n</style>\n\n\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\nFor major changes, please open an issue first to discuss what you would\nlike to change.\n\n## Citation\n\nIf you use tsfast in your research, please cite:\n\n``` text\n@Misc{tsfast,\nauthor = {Daniel O.M. Weber},\ntitle = {tsfast - A deep learning library for time series analysis and system identification},\nhowpublished = {Github},\nyear = {2024},\nurl = {https://github.com/daniel-om-weber/tsfast}\n}\n```\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "A description of your project",
"version": "0.1.5",
"project_urls": {
"Homepage": "https://github.com/daniel-om-weber/tsfast"
},
"split_keywords": [
"fastai",
"time-series",
"system-identification",
"deep-learning",
"pytorch",
"fransys"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "a21b1b127fc8b277b2e7dfd7b280a2c8783b8b3f94f2b4af9a33efe56c9b231a",
"md5": "c3b68462e7fdc1fa1b731abc803cffd4",
"sha256": "9d7935b25f6bfd61392aeb55615e85288151d5f39862be55e584c070db3b78f4"
},
"downloads": -1,
"filename": "tsfast-0.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c3b68462e7fdc1fa1b731abc803cffd4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 72692,
"upload_time": "2025-07-08T15:48:35",
"upload_time_iso_8601": "2025-07-08T15:48:35.134895Z",
"url": "https://files.pythonhosted.org/packages/a2/1b/1b127fc8b277b2e7dfd7b280a2c8783b8b3f94f2b4af9a33efe56c9b231a/tsfast-0.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "819c2dbfebaa53f7b83c3e7594522777796f22e35dae095d57c8086af032ad40",
"md5": "6a7ce86d6a7c9ff391ae19425cb74931",
"sha256": "38fff1410aaa043dd96f3b84ecaa574d40403bec3d0557de2af59eab32c67e57"
},
"downloads": -1,
"filename": "tsfast-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "6a7ce86d6a7c9ff391ae19425cb74931",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 15340837,
"upload_time": "2025-07-08T15:48:37",
"upload_time_iso_8601": "2025-07-08T15:48:37.679431Z",
"url": "https://files.pythonhosted.org/packages/81/9c/2dbfebaa53f7b83c3e7594522777796f22e35dae095d57c8086af032ad40/tsfast-0.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-08 15:48:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "daniel-om-weber",
"github_project": "tsfast",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "tsfast"
}
JSON
