Skip to main content

Aspect-based Forecasting Accuracy

Project description

Model Radar 🎯

A framework for aspect-based evaluation of time series forecasting models based on Nixtla's ecosystem.

PyPi Version GitHub Downloads

Overview

Model Radar introduces a novel aspect-based forecasting evaluation approach that goes beyond traditional aggregate metrics. Our framework enables:

  • Fine-grained performance analysis across different forecasting aspects
  • Better understanding of model behavior in varying conditions
  • More informed model selection based on specific use case requirements

🚀 Getting Started

Check the notebooks folder for usage examples and tutorials.

Check ModelRadar-Experiments repository for a thorough application of ModelRadar.

Installation

You can install modelradar using pip:

pip install modelradar

[Optional] Installation from source

To install modelradar from source, clone the repository and run the following command:

git clone https://github.com/vcerqueira/modelradar
pip install -e modelradar

Prerequisites

Required dependencies:

utilsforecast==0.2.11
numpy==1.26.4
plotnine==0.14.5

⚠️ I've noticed some issues when running with more recent versions of numpy and utilsforecast. Try to use the versions above.

Examples

Besides the examples in the notebooks folder, here's some outputs you can get from modelradar:

  • Spider chart with overview on several dimensions:

radar

  • Parallel coordinates chart with overview on several dimensions:

radar2

  • Barplot chart controlling for a given variable (in this case, anomaly status):

radar2

  • Grouped bar plot showing win/draw/loss ratios wrt different models:
radar2

📑 References

Cerqueira, V., Roque, L., & Soares, C. "Forecasting with Deep Learning: Beyond Average of Average of Average Performance." Discovery Science: 27th International Conference, DS 2024, Pisa, Italy, 2024, Proceedings 27. Springer International Publishing, 2024.

Check DS24 folder to reproduce the experiments published on this paper. The main repository and package contains an updated framework.

⚠️ WARNING

modelradar is in the early stages of development. The codebase may undergo significant changes. If you encounter any issues, please report them in GitHub Issues

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

modelradar-0.2.1.tar.gz (6.7 MB view details)

Uploaded Source

Built Distribution

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

modelradar-0.2.1-py3-none-any.whl (19.2 kB view details)

Uploaded Python 3

File details

Details for the file modelradar-0.2.1.tar.gz.

File metadata

  • Download URL: modelradar-0.2.1.tar.gz
  • Upload date:
  • Size: 6.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.15

File hashes

Hashes for modelradar-0.2.1.tar.gz
Algorithm Hash digest
SHA256 cc0106c28b1b471d22922e5f7647e368a2de038d7f547204eb12a21418262793
MD5 5c4c8c4f7372806d71f4d51da3d21814
BLAKE2b-256 fbf5e27a310309644496564ec8f9e50f91c51bb1bb4a418bcf20382dace3adf2

See more details on using hashes here.

File details

Details for the file modelradar-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: modelradar-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 19.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.10.15

File hashes

Hashes for modelradar-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 79c67a339fb14a5a1866cd2eb3065446dfb1e52e3afe4970c10309f1fc874c21
MD5 343badab26f2dc32c14fa100dc6acb66
BLAKE2b-256 6a526ffce2ba6981c298c506d444915ac64c2fbd40dc88b17b083bb621648bec

See more details on using hashes here.

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