Skip to content
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.

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

Add examples of newly added feature to the documents #5286

Open
Alnusjaponica opened this issue Feb 29, 2024 · 0 comments
Open

Add examples of newly added feature to the documents #5286

Alnusjaponica opened this issue Feb 29, 2024 · 0 comments
Labels
document Documentation related.

Comments

@Alnusjaponica
Copy link
Collaborator

What is an issue?

Motivation

Follow up #4986 and #4871

Details

Use newly added feature in the examples written in docstrings. To be specific,

Example:
The following code snippet shows how to plot hyperparameter importances.
.. plotly::
import optuna
def objective(trial):
x = trial.suggest_int("x", 0, 2)
y = trial.suggest_float("y", -1.0, 1.0)
z = trial.suggest_float("z", 0.0, 1.5)
return x ** 2 + y ** 3 - z ** 4
sampler = optuna.samplers.RandomSampler(seed=10)
study = optuna.create_study(sampler=sampler)
study.optimize(objective, n_trials=100)
fig = optuna.visualization.plot_param_importances(study)
fig.show()
sould be rewritten or have new examples.

Also, one of the tasks described in #4871 (comment) seems not resolved.

@Alnusjaponica Alnusjaponica added the document Documentation related. label Feb 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
document Documentation related.
Projects
None yet
Development

No branches or pull requests

1 participant