Enhance Optuna Visualization with Advanced Plotting for Optimization History

[nourbc211]

Contributor Agreements

Please read the contributor agreements and if you agree, please click the checkbox below.

• [ x] I agree to the contributor agreements.

Motivation

This pull request enhances Optuna’s visualization by introducing new customization options, improving the clarity and interpretability of optimization history plots.Originally, this feature was proposed in the main Optuna repository, but it was suggested by a maintainer that OptunaHub would be a more suitable location.

Description of the changes

•	Added display_param_label: Displays detailed parameter labels on hover for each trial.
•	Added view_x_in_log_scale: Enables a logarithmic x-axis scale for trial numbers, ideal for extensive trials.
•	Added display_log_difference: Plots the log difference between each trial’s objective value and the best value so far, aiding in convergence analysis.

TODO List towards PR Merge

Please remove this section if this PR is not an addition of a new package.
Otherwise, please check the following TODO list:

• [ x] Copy ./template/ to create your package
• [x ] Replace <COPYRIGHT HOLDER> in LICENSE of your package with your name
• [x ] Fill out README.md in your package
• [ x] Add import statements of your function or class names to be used in __init__.py
• [x ] (Optional) Add from __future__ import annotations at the head of any Python files that include typing to support older Python versions
• [x ] Apply the formatter based on the tips in README.md
• [x ] Check whether your module works as intended based on the tips in README.md

[y0z]

Thank you for your contribution!
To merge this PR, several fixes are needed.

Please update your PR following the comments below.

• Please move the optuna_enhanced_visualization directory under optunahub-registry/package/visualization like this.
• Please do not change .pre-commit-config.yaml in this PR since it is irrelevant to your visualization package.
• optuna_enhanced_visualization/example.py and test_optu.py can be removed.

The following tutorials will help you update your PR. These documentations provide information to correctly and properly implement visualization packages and register the package.

• How to Implement Your Own Visualization Function
• How to Register Your Algorithm with OptunaHub
• How to Debug Your Algorithm Before Registering in OptunaHub

Seeing PRs already merged to add visualization functionalities, e.g., #144, is also an excellent way to understand the proper process.

If you have any difficulties fixing the PR, please let me know.

[y0z]

Please do not load the package from your fork of optunahub-registry.
I think this test file can be removed since it simply loads the module.

Suggested change

	module = optunahub.load_module(
	package="optuna_enhanced_visualization",
	repo_owner="nourbc211",
	ref="main",
	)
	module = optunahub.load_module(
	package="visualization/optuna_enhanced_visualization",
	)

[y0z]

Please use optunahub.load_module to load your package.

[nourbc211]

Thank you for your feedback! I'll make the changes asap

[nourbc211]

i have an issue caused by the readme file when pre-commit/action but i don't see where the problem could be. the .pre-commit-config.yaml is supposed to exclude this file anyway. Do you have an idea of what i could do to fix it ?

[y0z]

Your README may have a format error. Please correct the format carefully.

I discovered a problem.
Using display_param_label and display_log_difference simultaneously causes TypeError.
Could you fix this?

fig = plot_optimization_history(
    study,
    display_param_label=True,
    view_x_in_log_scale=False,
    display_log_difference=True,
)
fig.show()

    f"{plot_values[idx]:.4f}<br>{params}"
      ^^^^^^^^^^^^^^^^^^^^^^
TypeError: unsupported format string passed to NoneType.__format__

[y0z]

Due to a lack of reaction, I close this PR. If you want to continue working on this task, please reopen this PR.