Remove description about optuna study optimize from examples and docs.

[toshihikoyanase]

Motivation

#1384 deprecated the optuna study optimize command, but many examples have descriptions about it at the top of the files. I think we can remove them for consistency.

Description

Please remove the descriptions about optuna study optimize from example files.

• docs/source/faq.rst (this section)
• docs/source/tutorial/cli.rst
• docs/source/tutorial/configurations.rst
• examples/allennlp/allennlp_jsonnet.py
• examples/allennlp/allennlp_simple.py
• examples/catalyst_simple.py
• examples/catboost_simple.py
• examples/chainer_simple.py
• examples/dask_ml_simple.py
• examples/keras_simple.py
• examples/lightgbm_simple.py
• examples/lightgbm_tuner_cv.py
• examples/lightgbm_tuner_simple.py
• examples/mxnet_simple.py
• examples/optuna_search_cv_simple.py
• examples/pytorch_ignite_simple.py
• examples/pytorch_lightning_simple.py
• examples/pytorch_simple.py
• examples/quadratic_simple.py
• examples/skimage_lbp_simple.py
• examples/sklearn_additional_args.py
• examples/sklearn_simple.py
• examples/tensorflow_eager_simple.py
• examples/tensorflow_estimator_simple.py
• examples/xgboost_simple.py

Example

This is just an example of the fix. Please feel free to change it depending on the examples.

Before:

We have the following two ways to execute this example:

(1) Execute this code directly.
    $ python quadratic_simple.py


(2) Execute through CLI.
    $ STUDY_NAME=`optuna create-study --storage sqlite:///example.db`
    $ optuna study optimize quadratic_simple.py objective --n-trials=100 --study-name $STUDY_NAME \
      --storage sqlite:///example.db

After:

You can run this example as follows:
    $ python quadratic_simple.py

[ritvik1512]

I would like to try to tackle this. Thanks!

[ritvik1512]

I would like to confirm, as the command optuna study optimize itself is deprecated, should I also remove entire section related to optimzation through study optimize?

For example, docs/source/tutorial/cli.rst has a section on optimization at the very end, does that needs to be removed completely? Thank you

[github-actions]

This issue has not seen any recent activity.

[himkt]

@ritvik1512

Thank you for your interest on the issue and really sorry for the late reply.
We'd like to work on this issue by the following steps:

1. Remove instructions for optuna study optimize in examples ← [now]
2. Remove the documentation for optuna study optimize
3. Update tutorial. In our documentation, it doesn't describe the usage of several commands in Optuna CLI commands: storage update, studies, create study, and dashboard. We need to create tutorials for them. Let me create another issue for this task.

So, for this issue, we can concentrate on removing descriptions for optuna study optimize from examples. Please focus on step #1 if you are still interested in this issue.

Thanks,

[ritvik1512]

Thank you for taking the time to list out the steps, I'll start with #1 for now.

[ritvik1512]

I have added PR #1566 that should address the removal of optuna study optimize from examples.

[toshihikoyanase]

#1566 removed the optuna study optimize from the examples. Thanks, @ritvik1512 !

The documents still contain the description of optuna study optimize. Please refer to this comment to find the details of the remaining tasks.

• docs/source/faq.rst (this section)
• docs/source/tutorial/cli.rst
• docs/source/tutorial/configurations.rst

[nzw0301]

I briefly re-organise #1394 (comment) to close this issue.

• docs/source/faq.rst (this section), resolved by Remove deprecated command optuna study optimize in FAQ #3364.
• tutorial/20_recipes/004_cli.py
• tutorial/10_key_features/002_configurations.py: there is not optuna study optimize anymore

tutorial/20_recipes/004_cli.py's main content, this page, is about this deprecated example, so I'm not sure how to change this tutorial...

[himkt]

[memo] In #3032, CLI tutorial is planned to be updated removing deprecated functionalities.