Skip to main content

A package for Forecast Evaluation

Project description

PyPI PyPI - Downloads

Forecast Evaluation Package

A Python package for analysing and visualising economic forecast data.

Installation

Installing from PyPI

pip install forecast_evaluation

Installing the development version

git clone https://github.com/bank-of-england/forecast_evaluation.git
cd forecast_evaluation
pip install -e .

Documentation

The package documentation can be found here with examples on how to use the package in this notebook.

Features

The package contains tools to inspect the accuracy, unbiasedness and efficiency of economic forecasts. It includes visualisation tools, statistical tests and accuracy metrics commonly used for forecast evaluation. In handles both point forecasts (with the ForecastData object) and density forecasts (with the DensityForecastData object).

Visualisation for forecasts, outturns and errors:

  • Forecast vintages plot
  • Accuracy and bias plots (average and rolling averages)
  • Hedgehog plots
  • Outturn revisions
  • Forecast error distributions
  • Forecast error correlation
  • Radar plots

Statistical tests

  • Accuracy analysis (Diebold-Mariano test)
  • Bias analysis (Mincer-Zarnowitz Regression)
  • Weak Efficiency analysis (Revision predictability)
  • Strong Efficiency analysis (Blanchard-Leigh regression)
  • Testing correlation between forecast revisions and forecast errors
  • Rolling-window analysis of most tests with fluctuation tests.

Accuracy metrics available

  • Root mean square error
  • Mean absolute error
  • Median absolute error

All of the above features can be explored interactively in a dashboard.

Loading data

Data format

The forecasts should be in a pandas dataframe format with the following structure:

            date vintage_date variable       source frequency  forecast_horizon  value
0     2014-12-31   2015-03-31      gdp        BVAR         Q                -1    100
1     2015-03-31   2015-03-31      gdp        BVAR         Q                 0    101
2     2015-06-30   2015-03-31      gdp        BVAR         Q                 1    102
3     2015-09-30   2015-03-31      gdp        BVAR         Q                 2    103

Outturns follow the same structure but do not contain a source column.

Creating a ForecastData instance

The package's main object is the ForecastData class which holds the outturns, forecasts, transformed forecasts and forecast errors. You can create an instance of this class with:

import forecast_evaluation as fe

forecast_data = fe.ForecastData(forecasts_data=forecasts_dataframe, outturns_data=outturns_dataframe)

The package also comes with built-in data used in the Bank of England 2026 Forecast Evaluation Report which can be loaded with:

forecast_data = fe.ForecastData(load_fer=True) 

The forecast_data object has methods to filter, analyse and visualise the data and resulting analysis. These are illustrated in the example notebook.

Results from the Bank of England 2026 Forecast Evaluation Macro Technical Paper can also be replicated with this notebook.

Run the dashboard

To make visualisation of forecasts and their properties easier, the package includes a dashboard. Once a ForecastData object has been created the dashboard can be run with:

forecast_data.run_dashboard()

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

forecast_evaluation-0.1.9.tar.gz (508.2 kB view details)

Uploaded Source

Built Distribution

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

forecast_evaluation-0.1.9-py3-none-any.whl (522.7 kB view details)

Uploaded Python 3

File details

Details for the file forecast_evaluation-0.1.9.tar.gz.

File metadata

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

File hashes

Hashes for forecast_evaluation-0.1.9.tar.gz
Algorithm Hash digest
SHA256 d89ce02fecfdba62747fbd225d06291c11d04aed5adbb9caddb35783502e5a7e
MD5 f883f9a5eb63ee067d74ee6e7a0e9fbd
BLAKE2b-256 a508ec4ad54c0c62b404892de6e7678fd253e87113b558381a2830d4a73372c7

See more details on using hashes here.

Provenance

The following attestation bundles were made for forecast_evaluation-0.1.9.tar.gz:

Publisher: publish.yml on bank-of-england/forecast_evaluation

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

File details

Details for the file forecast_evaluation-0.1.9-py3-none-any.whl.

File metadata

File hashes

Hashes for forecast_evaluation-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 8d78e7088498f606765b330044cb3789d73babeb1ec1470d9fc52899fa22ec0e
MD5 d9793712ded2cb25bda484fd2e035787
BLAKE2b-256 c14b5536f072dc1a575a8e39737a38820c84b8c3bf38ab287e8c6698f1a35d59

See more details on using hashes here.

Provenance

The following attestation bundles were made for forecast_evaluation-0.1.9-py3-none-any.whl:

Publisher: publish.yml on bank-of-england/forecast_evaluation

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