Deprecate optuna study optimize command.
#1384
Merged
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
hvy
requested changes
Jun 17, 2020
Co-authored-by: Hiroyuki Vincent Yamazaki <hiroyuki.vincent.yamazaki@gmail.com>
hvy
reviewed
Jun 17, 2020
| @@ -253,7 +253,7 @@ def take_action(self, parsed_args): | |||
|
|
|||
|
|
|||
| class _StudyOptimize(_BaseCommand): | |||
| """Start optimization of a study.""" | |||
| """Start optimization of a study. Deprecated since version 2.0.0.""" | |||
There was a problem hiding this comment.
This message might be a bit difficult to notice blending in, but it's not a strong opinion.
There was a problem hiding this comment.
I agree. This message is only shown in the list of commands. Do we remove it?
$ optuna
...
Commands:
complete print bash completion command (cliff)
create-study Create a new study.
dashboard Launch web dashboard (beta).
delete-study Delete a specified study.
help print detailed help for another command (cliff)
storage upgrade Upgrade the schema of a storage.
studies Show a list of studies.
study optimize Start optimization of a study. Deprecated since version 2.0.0.
study set-user-attr Set a user attribute to a study.
There was a problem hiding this comment.
I think we don't have to remove it. It's helpful for users.
HideakiImamura
approved these changes
Jun 17, 2020
25 tasks
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
Optuna provides the CLI to invoke optimization from the shell, but it does not support some features like the pruning and the callback. This PR proposes to remove it in the future instead of adding the new feature support because of the following reasons:
Description of the changes
This PR adds a deprecation warning to
optuna study optimizecommand.We need to update the code comment in the example files, but I leave them as they are to keep the diff small.