Skip to main content

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

Metadata

Release files for modelradar 0.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for modelradar 0.2.1
File Size Uploaded Provenance Actions
modelradar-0.2.1.tar.gz 6.7 MB Without provenance Details for modelradar-0.2.1.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for modelradar 0.2.1
File Interpreter ABI Platform Actions
modelradar-0.2.1-py3-none-any.whl Python 3 none any Details for modelradar-0.2.1-py3-none-any.whl

Total release size: 6.7 MB

Release files / modelradar-0.2.1.tar.gz

Download URL modelradar-0.2.1.tar.gz
Size 6.7 MB
Tags Source
SHA-256 checksum
How to use checksums
cc0106c28b1b471d22922e5f7647e368a2de038d7f547204eb12a21418262793
BLAKE2b-256 checksum
How to use checksums
fbf5e27a310309644496564ec8f9e50f91c51bb1bb4a418bcf20382dace3adf2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.10.15

Release files / modelradar-0.2.1-py3-none-any.whl

Download URL modelradar-0.2.1-py3-none-any.whl
Size 19.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
79c67a339fb14a5a1866cd2eb3065446dfb1e52e3afe4970c10309f1fc874c21
BLAKE2b-256 checksum
How to use checksums
6a526ffce2ba6981c298c506d444915ac64c2fbd40dc88b17b083bb621648bec
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.0.1 CPython/3.10.15

Security for modelradar 0.2.1

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page