Made error message easier to understand for create_study's direction #5806 #5839
Conversation
This file contains 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
|
Thank you for your PR. The original message is useful for wrong direction names, for example, "min." Could you add branching based on type? optuna.create_study(direction="min") |
|
@y0z Could you review this PR? |
y0z
added
the
code-fix
y0z
reviewed
Dec 11, 2024
There was a problem hiding this comment.
I think it will be mergeable once #5839 (comment) have been addressed.
|
I think the original comment should stay as is, but what we should check is whether the typing of |
|
This pull request has not seen any recent activity. |
|
This pull request was closed automatically because it had not seen any recent activity. If you want to discuss it, you can reopen it freely. |
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.
Motivation
Users sometimes pass a list of directions to the direction argument, expecting multi-objective optimization, when they should use directions instead.
The previous error message:
ValueError: Please set either 'minimize' or 'maximize' to direction. You can also set the corresponding 'StudyDirection' member.This message doesn't clearly explain that multi-objective optimization requires using directions. The updated message provides clearer guidance. The issue was raised in the #5806
Description of the changes
The error message is changed to
Use 'directions' instead of 'direction' for multi-objective optimization.