Skip to main content

pytspredit

PyPI version Python versions License: MIT

Python port of the R tspredit — time series prediction with tunable preprocessing, built on the DAL Toolbox Experiment Line.

pytspredit provides a uniform, extensible interface for time series forecasting: sliding-window modeling, normalization, filtering and augmentation, machine-learning and statistical regressors, and hyperparameter tuning — reusing the best of the Python ecosystem (scikit-learn, numpy, pandas, statsmodels) through thin adapters. Its value is not reimplementing algorithms, but the rigid, extensible interface that wraps them.

It is part of the DAL Python family:

  • Builds on pydaltoolbox — the foundation (Python port of the R daltoolbox), on PyPI.
  • Is, in turn, a dependency of pyharbinger (time series event detection).

Installation

pip install pytspredit

Beta: the current release (0.1.0) is in a testing phase on the way to 1.0.0. Feedback and issues are very welcome.

For a local, editable clone (contributing or running the examples):

git clone https://github.com/cefet-rj-dal/pytspredit.git
cd pytspredit
pip install -e ".[dev,docs]"
pytest

A forecast in a nutshell

import pytspredit as ts

series = ts.datasets.tsd()["y"]                  # example series
windows = ts.ts_data(series, sw=10)              # sliding windows: columns t9 ... t0
samp = ts.ts_sample(windows, test_size=5)        # temporal train/test split
io_train = ts.ts_projection(samp.train)          # -> (input X, output t0)
io_test = ts.ts_projection(samp.test)

# a kNN regressor with min-max normalization and PACF-based lag selection
model = ts.TsKnn(ts.TsNormGminmax(), input_size=4, input_map=ts.TsLagmap("pacf"), k=3)
model.fit(io_train.input, io_train.output)

forecast = model.predict(io_test.input.iloc[[0]], steps_ahead=5)   # 5 steps ahead
print(model.evaluate(io_test.output.to_numpy(), forecast)["metrics"])

Status

Published (0.4.0, beta). The port follows the method validated for pydaltoolbox (already on PyPI), with R-vs-Python parity checked at every step on the shared tsd series. Implemented:

  • Core data structures: ts_data (sliding windows), ts_projection, ts_sample, adjust_ts_data, ts_head, datasets.tsd() (numerically identical to R).
  • Regression base: TsReg (MSE / sMAPE / R2 evaluation) and TsRegSW (preprocess + lag map + backend; one-step and iterative multi-step forecasting).
  • Normalizations: TsNormNone, TsNormGminmax, TsNormSwminmax, TsNormDiff, TsNormAn (adaptive; 4 operators) — all invertible.
  • Lag mapping: TsLagmap with 12 strategies (recent, even, geom, acf, pacf, peaks, seasonal, acf/pacf-seasonal, blocks, mutual information, mRMR).
  • Regressors: TsKnn, TsElm, TsRf, TsSvm, TsMlp (sliding-window) and TsArima (univariate ARIMA).
  • Model zoo (0.2.0): TsDeterministic (TsPeriodic, TsPersist), TsDarima and TsWarma (window linear models) — no new dependencies.
  • Augmentation (0.3.0): TsAugNone, TsAugFlip, TsAugStretch, TsAugShrink, TsAugJitter, TsAugWormhole, TsAugAwareness, TsAugAwaresmooth (native) — plug into TsIntegtune's augmentation slot.
  • Filters (0.4.0): TsFilNone/Ma/Ema/Winsor/Recursive/Fft/Smooth/Hp/Gabor (native, R-exact) + TsFilLowess/Ses/Qes/SeasAdj/Spline/Kalman (statsmodels/scipy). Adds scipy as a (lightweight) core dependency.
  • Tuning: TsTune and TsIntegtune (integrated tuning of input size, preprocessing and model hyperparameters).

Thin adapters over scikit-learn / numpy / pandas / statsmodels reproduce the R backends' defaults (e.g. SVM standardizes like e1071). Deferred to a later release (see develop/planejamento.md): the multivariate family (ts_data_mv, ts_var, ts_arimax), filters, the full augmentation family, and graphics.

Documentation

License

MIT

Metadata

Release files for pytspredit 0.4.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pytspredit 0.4.0
File Size Uploaded Provenance Actions
pytspredit-0.4.0.tar.gz 32.8 kB Without provenance Details for pytspredit-0.4.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for pytspredit 0.4.0
File Interpreter ABI Platform Actions
pytspredit-0.4.0-py3-none-any.whl Python 3 none any Details for pytspredit-0.4.0-py3-none-any.whl

Total release size: 70.4 kB

Release files / pytspredit-0.4.0.tar.gz

Download URL pytspredit-0.4.0.tar.gz
Size 32.8 kB
Tags Source
SHA-256 checksum
How to use checksums
2030934a67727bd8c3ef5383651b59b2c9f7be7b75693e4bba650fbe9395d9b5
BLAKE2b-256 checksum
How to use checksums
0ec3e376eabb2ffc96029a7abf34f8a04e494d7eab5366e8ea673f0db0caff4c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.0

Release files / pytspredit-0.4.0-py3-none-any.whl

Download URL pytspredit-0.4.0-py3-none-any.whl
Size 37.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c0e25f9dd264ee18bf041f92bac6b924d4ccfe4b28b67c89bf59cbca39ca3534
BLAKE2b-256 checksum
How to use checksums
0d110c3af8751f203c68ceef7e438b3c8198cde1918c8f5358008319d24dd8d0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.0

Security for pytspredit 0.4.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page