A Nixtla integration for Yohou
Project description
What is Yohou-Nixtla?
Yohou-Nixtla brings the power of Nixtla's forecasting ecosystem to Yohou, providing Yohou-compatible wrappers for statistical, machine learning, and deep learning time series models.
This integration enables you to use Nixtla's high-performance forecasters (StatsForecast, NeuralForecast) within Yohou's unified API for time series forecasting. All models work seamlessly with Yohou's features: polars DataFrames, panel data support, cross-validation, and hyperparameter search via GridSearchCV/RandomizedSearchCV.
What are the features of Yohou-Nixtla?
- Statistical Models: AutoARIMA, AutoETS, AutoTheta, ARIMA, Holt-Winters, Naive, and more from StatsForecast, providing fast, production-ready statistical forecasters.
- Neural Models: NBEATS, NHITS, MLP, PatchTST, TimesNet from NeuralForecast, offering state-of-the-art deep learning architectures.
- Panel Data: Native support for multiple time series with
__column naming convention (e.g.,sales__store_1,sales__store_2). - Yohou Compatible: Full
fit/predict,get_params/set_params,clonecompatibility. Works with GridSearchCV, pipelines, and the Yohou ecosystem. - Polars Native: All data handling uses polars DataFrames for high-performance time series operations.
Note: Nixtla's MLForecast is not wrapped as Yohou already provides
PointReductionForecaster, which turns any scikit-learn regressor (Ridge, LightGBM, XGBoost, …) into a recursive multi-step forecaster with full support for feature transformers, target transformers, and panel data.
How to install Yohou-Nixtla?
Install the Yohou-Nixtla package using pip:
pip install yohou_nixtla
or using uv:
uv pip install yohou_nixtla
or using conda:
conda install -c conda-forge yohou_nixtla
or using mamba:
mamba install -c conda-forge yohou_nixtla
or alternatively, add yohou_nixtla to your requirements.txt or pyproject.toml file.
How to get started with Yohou-Nixtla?
1. Fit a Statistical Forecaster
Use AutoARIMA for automatic ARIMA model selection:
import polars as pl
from yohou_nixtla import AutoARIMAForecaster
# Load your time series data (must have a "time" column)
y = pl.DataFrame({
"time": pl.datetime_range(start="2020-01-01", end="2020-12-31", interval="1d", eager=True),
"sales": [100 + i * 0.5 + (i % 7) * 10 for i in range(366)],
})
# Fit and predict
forecaster = AutoARIMAForecaster(season_length=7)
forecaster.fit(y, forecasting_horizon=14)
y_pred = forecaster.predict()
2. Train Deep Learning Models
Neural models for complex patterns:
from yohou_nixtla import NHITSForecaster
forecaster = NHITSForecaster(input_size=30, max_steps=100)
forecaster.fit(y, forecasting_horizon=14)
y_pred = forecaster.predict()
3. Panel Data Forecasting
Forecast multiple time series simultaneously:
# Panel data with __ separator
y_panel = pl.DataFrame({
"time": pl.datetime_range(start="2020-01-01", end="2020-12-31", interval="1d", eager=True),
"sales__store_1": [...],
"sales__store_2": [...],
})
forecaster = AutoARIMAForecaster(season_length=7)
forecaster.fit(y_panel, forecasting_horizon=14)
y_pred = forecaster.predict() # Predictions for all stores
How do I use Yohou-Nixtla?
Full documentation is available at https://yohou-nixtla.readthedocs.io/.
Interactive examples are available in the examples/ directory:
- Online: https://yohou-nixtla.readthedocs.io/en/latest/pages/examples/
- Locally: Run
marimo edit examples/hello.pyto open an interactive notebook
Can I contribute?
We welcome contributions, feedback, and questions:
- Report issues or request features: GitHub Issues
- Join the discussion: GitHub Discussions
- Contributing Guide: CONTRIBUTING.md
If you are interested in becoming a maintainer or taking a more active role, please reach out to Guillaume Tauzin on GitHub Discussions.
Where can I learn more?
Here are the main Yohou-Nixtla resources:
- Full documentation: https://yohou-nixtla.readthedocs.io/
- GitHub Discussions: https://github.com/stateful-y/yohou-nixtla/discussions
- Interactive Examples: https://yohou-nixtla.readthedocs.io/en/latest/pages/examples/
For questions and discussions, you can also open a discussion.
License
This project is licensed under the terms of the Apache-2.0 License.
Acknowledgements
This project is maintained by stateful-y, an ML consultancy specializing in time series data science & engineering. If you're interested in collaborating or learning more about our services, please visit our website.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file yohou_nixtla-0.1.0a3.tar.gz.
File metadata
- Download URL: yohou_nixtla-0.1.0a3.tar.gz
- Upload date:
- Size: 152.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c879a9dceaccb868102ebde7aba79d8b002f9f7edd81f7fd365e60f5181f0eba
|
|
| MD5 |
5f2d5231c50205e3aca521d3ce449354
|
|
| BLAKE2b-256 |
12a6266c4dd9c100d105453c3c4b3614473534d0a78ed64757014472eade47ff
|
Provenance
The following attestation bundles were made for yohou_nixtla-0.1.0a3.tar.gz:
Publisher:
publish-release.yml on stateful-y/yohou-nixtla
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
yohou_nixtla-0.1.0a3.tar.gz -
Subject digest:
c879a9dceaccb868102ebde7aba79d8b002f9f7edd81f7fd365e60f5181f0eba - Sigstore transparency entry: 1356954709
- Sigstore integration time:
-
Permalink:
stateful-y/yohou-nixtla@53ee2fcb938e1c5f8afec41204e0de6d26b1cd37 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/stateful-y
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-release.yml@53ee2fcb938e1c5f8afec41204e0de6d26b1cd37 -
Trigger Event:
pull_request
-
Statement type:
File details
Details for the file yohou_nixtla-0.1.0a3-py3-none-any.whl.
File metadata
- Download URL: yohou_nixtla-0.1.0a3-py3-none-any.whl
- Upload date:
- Size: 26.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7a2cfc6b917bb6f1972f0a6d325716aafa6d8ffc60bbbf155dfe15e33ba83766
|
|
| MD5 |
e8a4e45b885f9bf46110fec9aa27d4d4
|
|
| BLAKE2b-256 |
4f66c49e8113f61e31db6d7266608ae03f2490ce7064afc5067cb7c0e8a1ac60
|
Provenance
The following attestation bundles were made for yohou_nixtla-0.1.0a3-py3-none-any.whl:
Publisher:
publish-release.yml on stateful-y/yohou-nixtla
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
yohou_nixtla-0.1.0a3-py3-none-any.whl -
Subject digest:
7a2cfc6b917bb6f1972f0a6d325716aafa6d8ffc60bbbf155dfe15e33ba83766 - Sigstore transparency entry: 1356954720
- Sigstore integration time:
-
Permalink:
stateful-y/yohou-nixtla@53ee2fcb938e1c5f8afec41204e0de6d26b1cd37 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/stateful-y
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish-release.yml@53ee2fcb938e1c5f8afec41204e0de6d26b1cd37 -
Trigger Event:
pull_request
-
Statement type: