Skip to content

refactor: separate performance_metrics into metrics module to resolve circular import - #2747

Open
fabiooliveir wants to merge 2 commits into
facebook:mainfrom
fabiooliveir:refactor/modularize-metrics
Open

fabiooliveir wants to merge 2 commits into
facebook:mainfrom
fabiooliveir:refactor/modularize-metrics

Conversation

@fabiooliveir

Copy link
Copy Markdown

Summary

This PR addresses the TODO in prophet/plot.py:

# TODO: separate performance_metrics into a different module. there is an implicit circular import between forecaster.py and diagnostics.py

Changes

  • Created prophet/metrics.py containing all pure evaluation metrics (mse, rmse, mae, mape, mdape, smape, coverage), rolling aggregation helpers (rolling_mean_by_h, rolling_median_by_h), and performance_metrics.
  • Updated prophet/plot.py to import performance_metrics from prophet.metrics instead of prophet.diagnostics.
  • Re-exported all metrics and helper symbols in prophet/diagnostics.py to maintain 100% backward compatibility for existing code.
  • Added dedicated unit tests in prophet/tests/test_metrics.py (19 test cases covering functionality and backward compatibility).

Test Plan

  • python -m pytest prophet/tests/test_metrics.py passed (19/19 passed).
  • python -m pytest prophet/tests/test_diagnostics.py passed (26/26 passed).
  • Static type check (pyrefly check) passed with 0 errors on prophet/metrics.py.

… circular import

Address TODO in prophet/plot.py by extracting pure evaluation metrics to prophet/metrics.py. Re-export all symbols from prophet/diagnostics.py for backward compatibility. Add dedicated test suite in prophet/tests/test_metrics.py.
@meta-cla

meta-cla Bot commented Sep 11, 2026

Copy link
Copy Markdown

Hi @fabiooliveir!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks!

@meta-cla

meta-cla Bot commented Sep 11, 2026

Copy link
Copy Markdown

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

@meta-cla meta-cla Bot added the CLA Signed label Sep 11, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant