Repository navigation
Add signed option to ope() for percentage bias - #3319
Merged
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #3319 +/- ##
=======================================
Coverage 97.15% 97.15%
=======================================
Files 175 175
Lines 19468 19469 +1
=======================================
+ Hits 18914 18915 +1
Misses 554 554 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
dennisbader
approved these changes
Oct 29, 2026
dennisbader
left a comment
Collaborator
There was a problem hiding this comment.
Thanks a lot for the PR @COMPUMAX-EC 🚀
Everything looks good to me 💯
I simplified the tests to reuse the reference OPE.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Checklist before merging this PR:
ok).Fixes #3310.
Summary
Adds a
signed: bool = Falseparameter todarts.metrics.ope(). Withsigned=True, the absolute value is not taken, so the metric returns the signed overall percentage error (percentage bias). The default behavior does not change.opeformula, (Σy − Σŷ) / Σy: positive means under-forecasting and negative means over-forecasting. If you'd rather have positive mean over-forecasting, as the issue suggests, it's a one-line change.test_ope_signed, covers both signs, the default, multivariate and multi-series inputs, stochastic forecasts withq, and zero division.Other Information
pytest darts/tests/metrics/test_metrics.py: 487 passed locally (Windows, Python 3.12). Ruff 0.7.2checkandformat --checkpass.