Remove description about `optuna study optimize` from examples and docs.
See original GitHub issueMotivation
#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
Issue Analytics
- State:
- Created 3 years ago
- Comments:9 (7 by maintainers)
Top Results From Across the Web
optuna.study. - trials - Read the Docs
A study corresponds to an optimization task, i.e., a set of trials. This object provides interfaces to run a new Trial , access...
Read more >optuna.study.delete_study - Read the Docs
Delete a Study object. Example. import optuna def objective(trial): x ... storage="sqlite:///example.db") study.optimize(objective, n_trials=3) ...
Read more >optuna.study — Optuna 3.0.5 documentation
A study corresponds to an optimization task, i.e., a set of trials. optuna.study.create_study. Create a new Study .
Read more >optuna.study.Study — Optuna 2.0.0 documentation
A study corresponds to an optimization task, i.e., a set of trials. This object provides interfaces to run a new Trial , access...
Read more >FAQ — Optuna 3.0.4 documentation
How do I avoid running out of memory (OOM) when optimizing studies? ... For example, you can save SVM models trained in the...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
I have added PR #1566 that should address the removal of
optuna study optimize
from examples.Thank you for taking the time to list out the steps, I’ll start with #1 for now.