Skip to content

Added warning to run_model_on_task to avoid duplicates if no authentication #1246

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.

Sign up for GitHub

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

Merged
PGijsbers merged 3 commits into from
Jun 13, 2023
Merged

Added warning to run_model_on_task to avoid duplicates if no authentication #1246

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
54cc435
Update runs/functions.py
v-parmar Apr 18, 2023
f7c583b
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 18, 2023
995f896
Update functions.py
v-parmar Apr 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Update functions.py
  • Loading branch information
@v-parmar
v-parmar authored Apr 25, 2023
commit 995f896cf69456f6b00b93d3c6521cc3f3c6f54e
6 changes: 3 additions & 3 deletions openml/runs/functions.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,9 +101,9 @@ def run_model_on_task(
if avoid_duplicate_runs and not config.apikey:
warnings.warn(
"avoid_duplicate_runs is set to True, but no API key is set. "
"Please set your API key in the OpenML configuration file "
"or pass it directly to the function.",
DeprecationWarning,
"Please set your API key in the OpenML configuration file, see"
"https://openml.github.io/openml-python/main/examples/20_basic/introduction_tutorial.html#authentication"
"for more information on authentication.",
)
Comment on lines +102 to +107
Copy link
Copy Markdown
Collaborator

@PGijsbers PGijsbers Apr 25, 2023

Choose a reason for hiding this comment

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

Suggested change
warnings.warn(
"avoid_duplicate_runs is set to True, but no API key is set. "
"Please set your API key in the OpenML configuration file "
"or pass it directly to the function.",
DeprecationWarning,
)
warnings.warn(
"avoid_duplicate_runs is set to True, but no API key is set. "
"Please set your API key in the OpenML configuration file, see"
"https://openml.github.io/openml-python/main/examples/20_basic/introduction_tutorial.html#authentication"
" for more information on authentication.",
)

Two changes:

  1. I don't think DeprecationWarning is appropriate here because we are not informing about changed behavior/signature of the function, I would favor the UserWarning (which is the default warning type, so I left that argument implicit).
  2. There is no way to pass the API key to the function, so that help text is incorrect. I updated the text to point to the documentation.


# TODO: At some point in the future do not allow for arguments in old order (6-2018).
Expand Down