Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] correct docstring of BaseForecaster.score, reference to use of non-symmetric MAPE #4948

Merged
merged 4 commits into from Jul 26, 2023

Conversation

MBristle
Copy link
Contributor

@MBristle MBristle commented Jul 24, 2023

Reference Issues/PRs

Fixes #4947

What does this implement/fix? Explain your changes.

The default value of the mean_absolute_percentage_error function changed to the non-symmetric MAPE. This has been made explicit, and the doc-string is adjusted.

Does your contribution introduce a new dependency? If yes, which one?

none

What should a reviewer concentrate their feedback on?

Was the change from symmetric - MAPE to non-symmetric MAPE intended for the score function of the BaseForecaster?
How are down-stream tasks affected in either way?

Did you add any tests for the change?

Functionality was not changed.

Any other comments?

PR checklist

For all contributions
  • I've added myself to the list of contributors with any new badges I've earned :-)
    How to: add yourself to the all-contributors file in the sktime root directory (not the CONTRIBUTORS.md). Common badges: code - fixing a bug, or adding code logic. doc - writing or improving documentation or docstrings. bug - reporting or diagnosing a bug (get this plus code if you also fixed the bug in the PR).maintenance - CI, test framework, release.
    See here for full badge reference
  • Optionally, I've added myself and possibly others to the CODEOWNERS file - do this if you want to become the owner or maintainer of an estimator you added.
    See here for further details on the algorithm maintainer role.
  • The PR title starts with either [ENH], [MNT], [DOC], or [BUG]. [BUG] - bugfix, [MNT] - CI, test framework, [ENH] - adding or improving code, [DOC] - writing or improving documentation or docstrings.
For new estimators
  • I've added the estimator to the API reference - in docs/source/api_reference/taskname.rst, follow the pattern.
  • I've added one or more illustrative usage examples to the docstring, in a pydocstyle compliant Examples section.
  • If the estimator relies on a soft dependency, I've set the python_dependencies tag and ensured
    dependency isolation, see the estimator dependencies guide.

The default value of the mean_absolute_percentage_error function changed to the non-symmetric MAPE. This has been made explicit, and the doc-string is adjusted.
@fkiraly fkiraly changed the title [DOC] adapt doc-string, make change to sMAPE error explicit [DOC] correct docstring of BaseForecaster.score, reference to use of non-symmetric MAPE Jul 24, 2023
Copy link
Collaborator

@fkiraly fkiraly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the fix!

One change request - the file CONTRIBUTORS.md should not be changed directly, this is automatically populated from .all-contributorsrc (so your change would be reverted at the next auto-update). Please change the latter, the all-contributorsrc, that's the "ground truth".

@fkiraly fkiraly added documentation Documentation & tutorials module:forecasting forecasting module: forecasting, incl probabilistic and hierarchical forecasting labels Jul 24, 2023
The default value of the mean_absolute_percentage_error function changed to the non-symmetric MAPE. This has been made explicit, and the doc-string is adjusted.

extend contributors list

fixes sktime#4947
@MBristle MBristle requested a review from fkiraly July 24, 2023 20:38
Copy link
Collaborator

@fkiraly fkiraly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good now!

@fkiraly
Copy link
Collaborator

fkiraly commented Jul 26, 2023

Was the change from symmetric - MAPE to non-symmetric MAPE intended for
the score function of the BaseForecaster?

That's a good question - I think the default changed simply since the non-symmetric version is more common, and more in line with the user expectation when reading the class name. As long as the docstring is consistent, all should be fine?

Downstream tasks - like tuning - afaik are not affected as the user always specifies the metric themselves, and there the docstrings are correct.

@fkiraly fkiraly merged commit b1921da into sktime:main Jul 26, 2023
24 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Documentation & tutorials module:forecasting forecasting module: forecasting, incl probabilistic and hierarchical forecasting
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] BaseForecaster score function uses MAPE instead of sMAPE as metric
2 participants