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

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.6.tar.gz (495.4 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.6-py3-none-any.whl (509.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: forecast_evaluation-0.1.6.tar.gz
  • Upload date:
  • Size: 495.4 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.6.tar.gz
Algorithm Hash digest
SHA256 594e373a37c02d76593d96a495187f5bbd969fc93913f73a1e163c7014604232
MD5 73719d4529d9de79dc1f4055e8f4f61a
BLAKE2b-256 9f44120b8c4c8560facf06d3eb908816f4a4156875fe2e080d14729f5a66f53e

See more details on using hashes here.

Provenance

The following attestation bundles were made for forecast_evaluation-0.1.6.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.6-py3-none-any.whl.

File metadata

File hashes

Hashes for forecast_evaluation-0.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 86666ce37d32a5a32ec7f9e04974cff73e1c8ca8238c0a663adf9c9a457a1773
MD5 13c0b5535fed8a6e44e6af820955f5c4
BLAKE2b-256 6360e269d04756a617de7d0770b17a5be8e8783ab19cba4ad3856a94f0fbac2f

See more details on using hashes here.

Provenance

The following attestation bundles were made for forecast_evaluation-0.1.6-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