Skip to main content

Forecast Reconciliation in Python

Project description

FoRecoPy: Forecast Reconciliation in Python logo

pytest codecov

Forecast reconciliation is a post-forecasting process aimed at improving the accuracy and coherence of forecasts for a system of linearly constrained time series (e.g., hierarchical, grouped, or temporal structures).

The FoRecoPy package is inspired by the R package FoReco and brings similar functionality to Python. It is designed for researchers, practitioners, and data scientists who use Python for time series forecasting and want access to state-of-the-art reconciliation methods.

Future versions will expand the scope to include the cross-temporal framework, non-negative constraints and probabilistic reconciliation.

Installation

Make sure to have a working JAX installation (please, follow these instructions).

To install the package from PyPI, call:

pip install forecopy

To install the latest GitHub , just call the following on the command line:

pip install git+https://github.com/danigiro/FoRecoPy@<RELEASE>

Features

  • Optimal combination reconciliation via projection and structural approaches
  • Tools for both cross-sectional (csrec) and temporal (terec) reconciliation
  • Different covariance matrix approximation
  • Support for custom aggregation or constraints matrices
  • Option to enforce non-negativity on reconciled forecasts
  • Efficient solvers suitable for high-dimensional problems

Quick Examples

Examples of cross-sectional and temporal forecast reconciliation are available here

License

MIT License. See LICENSE for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

forecopy-0.1.0.tar.gz (15.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

forecopy-0.1.0-py3-none-any.whl (16.8 kB view details)

Uploaded Python 3

File details

Details for the file forecopy-0.1.0.tar.gz.

File metadata

  • Download URL: forecopy-0.1.0.tar.gz
  • Upload date:
  • Size: 15.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for forecopy-0.1.0.tar.gz
Algorithm Hash digest
SHA256 07d81245cced7813fc4da1d4e415aacfaff749e3bf78846dd4b4a8e25966dc4c
MD5 a5f936a3a146cd7dd0bda30ff1930dae
BLAKE2b-256 c1288fb10ac87fcb4c462e5acc4ff07c3610f2259ff50f455b914ee5f45a779b

See more details on using hashes here.

Provenance

The following attestation bundles were made for forecopy-0.1.0.tar.gz:

Publisher: pypi.yml on danigiro/FoRecoPy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file forecopy-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: forecopy-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 16.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for forecopy-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 0cd0c86211aa154703552ffd2caf7e6f4ed1dc4435fcdc1b3e56933cfe3f63d5
MD5 487d5c96c15ff9faa79b093add1cb2f2
BLAKE2b-256 be4128236cd115c06845c22883650bcc992da04ff50ed1ed7af706187d0b7213

See more details on using hashes here.

Provenance

The following attestation bundles were made for forecopy-0.1.0-py3-none-any.whl:

Publisher: pypi.yml on danigiro/FoRecoPy

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page