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

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 Funded by

Agenda “Center for Responsible AI”, nr. C645008882-00000055, investment project nr. 62, financed by the Recovery and Resilience Plan (PRR) and by European Union - NextGeneration EU.

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.1.4.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.1.4-py3-none-any.whl (12.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: modelradar-0.1.4.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.1.4.tar.gz
Algorithm Hash digest
SHA256 56fa4ddb8707acd112768045c0c0dc7fbcea8d9f0c2fd68092c12b81ea7273cb
MD5 703172491ac506f7876e89a1be7b5a34
BLAKE2b-256 6574ed1191d200a9891cb8306d6894937e6ea14b9eb9efa15c89a2cb4d9345b9

See more details on using hashes here.

File details

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

File metadata

  • Download URL: modelradar-0.1.4-py3-none-any.whl
  • Upload date:
  • Size: 12.0 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.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 cd27bac57229d8fb19c7bed5123d96990abe9f376896181777db098126172866
MD5 b36f01ba2853847b88d35db21cd8a36e
BLAKE2b-256 848e7d58cea905bc62e8e5a4fbc00d6056408e2dcab940703575e511b5459e25

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