Methods for online / incremental estimation of distributional regression models
Project description
ROLCH: Regularized Online Learning for Conditional Heteroskedasticity
Introduction
This package provides an online estimation of models for distributional regression, respectively, models for conditional heteroskedastic data. The main contribution is an online/incremental implementation of the generalized additive models for location, shape and scale (GAMLSS, see Rigby & Stasinopoulos, 2005) developed in Hirsch, Berrisch & Ziel, 2024.
Please have a look at the documentation or the example notebook.
We're actively working on the package and welcome contributions from the community. Have a look at the Release Notes and the Issue Tracker.
Distributional Regression
The main idea of distributional regression (or regression beyond the mean, multiparameter regression) is that the response variable $Y$ is distributed according to a specified distribution $\mathcal{F}(\theta)$, where $\theta$ is the parameter vector for the distribution. In the Gaussian case, we have $\theta = (\theta_1, \theta_2) = (\mu, \sigma)$. We then specify an individual regression model for all parameters of the distribution of the form
$$g_k(\theta_k) = \eta_k = X_k\beta_k$$
where $g_k(\cdot)$ is a link function, which ensures that the predicted distribution parameters are in a sensible range (we don't want, e.g. negative standard deviations), and $\eta_k$ is the predictor. For the Gaussian case, this would imply that we have two regression equations, one for the mean (location) and one for the standard deviation (scale) parameters. Distributions other than the normal distribution are possible, and we have already implemented them, e.g., Student's $ t$ distribution and Johnson's $S_U$ distribution. If you are interested in another distribution, please open an Issue.
This allows us to specify very flexible models that consider the conditional behaviour of the variable's volatility, skewness and tail behaviour. A simple example for electricity markets is wind forecasts, which are skewed depending on the production level - intuitively, there is a higher risk of having lower production if the production level is already high since it cannot go much higher than "full load" and if, the turbines might cut-off. Modelling these conditional probabilistic behaviours is the key strength of distributional regression models.
Example
Basic estimation and updating procedure:
import rolch
import numpy as np
from sklearn.datasets import load_diabetes
X, y = load_diabetes(return_X_y=True)
# Model coefficients
equation = {
0 : "all", # Can also use "intercept" or np.ndarray of integers / booleans
1 : "all",
2 : "all",
}
# Create the estimator
online_gamlss_lasso = rolch.OnlineGamlss(
distribution=rolch.DistributionT(),
method="lasso",
equation=equation,
fit_intercept=True,
estimation_kwargs={"ic": {i: "bic" for i in range(dist.n_params)}},
)
# Initial Fit
online_gamlss_lasso.fit(
X=X[:-11, :],
y=y[:-11],
)
print("Coefficients for the first N-11 observations \n")
print(online_gamlss_lasso.betas)
# Update call
online_gamlss_lasso.update(
X=X[[-11], :],
y=y[[-11]]
)
print("\nCoefficients after update call \n")
print(online_gamlss_lasso.betas)
# Prediction for the last 10 observations
prediction = online_gamlss_lasso.predict(
X=X[-10:, :]
)
print("\n Predictions for the last 10 observations")
# Location, scale and shape (degrees of freedom)
print(prediction)
Installation & Dependencies
The package is available from pypi - do pip install rolch
and enjoy.
ROLCH
is designed to have minimal dependencies. We rely on python>=3.10
, numpy
, numba
and scipy
in a reasonably up-to-date versions.
Authors
- Simon Hirsch, University of Duisburg-Essen & Statkraft
- Jonathan Berrisch, University of Duisburg-Essen
- Florian Ziel, University of Duisburg-Essen
Acknowledgements & Disclosure
Simon is employed at Statkraft and gratefully acknowledges support received from Statkraft for his PhD studies. This work contains the author's opinion and not necessarily reflects Statkraft's position.
Contributing
We welcome every contribution from the community. Feel free to open an issue if you find bugs or want to propose changes.
We're still in an early phase and welcome feedback, especially on the usability and "look and feel" of the package. Secondly, we're working to port distributions from the R
-GAMLSS package and welcome according PRs.
To get started, just create a fork and get going. We will modularize the code over the next versions and increase our testing coverage. We use ruff
and black
as formatters.
Install from source:
- Clone this repo.
- Install the necessary dependencies from the
requirements.txt
usingconda create --name <env> --file requirements.txt
. - Run
python3 -m build
to build the wheel. - Run
pip install dist/rolch-0.1.0-py3-none-any.whl
with the accurate version. If necessary, append--force-reinstall
- Enjoy.O
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
File details
Details for the file rolch-0.1.9.tar.gz
.
File metadata
- Download URL: rolch-0.1.9.tar.gz
- Upload date:
- Size: 28.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.14
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f9d1ff9a3d5d6c25f01a075f24e248c9dac5ae9c457fec3f168719d549fc56d3 |
|
MD5 | c363b227ff1450050d69d9f022810cdd |
|
BLAKE2b-256 | c59ea16083bb448130442b67ce8e5c250ff0e586deca3904e8365ef762a378d0 |
File details
Details for the file rolch-0.1.9-py3-none-any.whl
.
File metadata
- Download URL: rolch-0.1.9-py3-none-any.whl
- Upload date:
- Size: 28.5 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.1 CPython/3.10.14
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 23945231e016200bd51aa298281102cd27047ca846019dfd1347f024909a4f70 |
|
MD5 | 34e6123839d2684344056f191490b1c8 |
|
BLAKE2b-256 | f023626123d6c6fa3f66d7e95a28a50da338e5189e4231e8eacee26335135fbe |