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.5.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).
  • Multivariate (0.5.0): ts_data_mv / adjust_ts_data_mv / ts_mv_spec, the sliding-window orchestrator TsRegswMv, and the singular (aligned) branch TsLmMv (linear regression), TsVar (vector autoregression) and TsArimax (ARIMA with external regressors) — all target-centered. Plus plot_ts_pred / plot_ts_pred_mv (matplotlib), adding matplotlib as a (lightweight) core dependency.

Every class documents its academic references and its R-port fidelity (References: / Porting: in the docstrings), mirroring the roxygen @references and @details of the R package. Thin adapters over scikit-learn / numpy / pandas / statsmodels reproduce the R backends' defaults (e.g. SVM standardizes like e1071). Deferred to the next cycle (see develop/planejamento.md): benchmark datasets, and the heavy-dependency extras (EMD, wavelets, full remote datasets).

Documentation

License

MIT

Metadata

Release files for pytspredit 0.5.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.5.0
File Size Uploaded Provenance Actions
pytspredit-0.5.0.tar.gz 48.9 kB Without provenance Details for pytspredit-0.5.0.tar.gz

Built distribution (wheel)

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

Total release size: 104.4 kB

Release files / pytspredit-0.5.0.tar.gz

Download URL pytspredit-0.5.0.tar.gz
Size 48.9 kB
Tags Source
SHA-256 checksum
How to use checksums
1694ccf72537c4a2b8235cd2bcb715817762968ff8d4e281e9a73a1b3f1c7b95
BLAKE2b-256 checksum
How to use checksums
99c759b542f4b7dfda160c66d4583db64d422dcebcb32ab344b72baea73bbe91
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.5.0-py3-none-any.whl

Download URL pytspredit-0.5.0-py3-none-any.whl
Size 55.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
ee351981f4918a7743a86e0320cae576654c4fd2eb0db53b0a181e4f2b8d6f34
BLAKE2b-256 checksum
How to use checksums
132633bae381d15f240421a5076104707c685be5a14f19e3c2d35bb6014f1148
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.5.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