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

Warn that the default score will change in 2.0 #352

Merged
merged 1 commit into from
Dec 23, 2021
Merged

Conversation

leouieda
Copy link
Member

@leouieda leouieda commented Dec 23, 2021

Issue a warning in the code and docstring that the default scoring
method used in the score method will change from R² to negative root
mean squared error.

Fixes #340

Reminders:

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst and the base __init__.py file for the package.
  • Write detailed docstrings for all functions/classes/methods. It often helps to design better code if you write the docstrings first.
  • If adding new functionality, add an example to the docstring, gallery, and/or tutorials.
  • Add your full name, affiliation, and ORCID (optional) to the AUTHORS.md file (if you haven't already) in case you'd like to be listed as an author on the Zenodo archive of the next release.

Issue a warning in the code and docstring that the default scoring
method used in the `score` method will change from R² to negative root
mean squared error.
@leouieda leouieda merged commit 6db6ba2 into main Dec 23, 2021
@leouieda leouieda deleted the deprecate-scoring branch December 23, 2021 13:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add deprecation warning for changing the default scoring method
1 participant