Skip to content

Add introduction of OptunaHub in docs#6171

Merged
nabenabe0928 merged 7 commits intooptuna:masterfrom
fusawa-yugo:fusawa-yugo/create_optunahub_intro
Jun 26, 2025
Merged

Add introduction of OptunaHub in docs#6171
nabenabe0928 merged 7 commits intooptuna:masterfrom
fusawa-yugo:fusawa-yugo/create_optunahub_intro

Conversation

@fusawa-yugo
Copy link
Copy Markdown
Contributor

Motivation

While there is information available on OptunaDashboard, it would be helpful to include an overview of OptunaHub as well.

Description of the changes

I added introduction of OptunaHub like below.
スクリーンショット 2025-06-20 17 11 19

@nabenabe0928 nabenabe0928 added the document Documentation related. label Jun 23, 2025
@nabenabe0928
Copy link
Copy Markdown
Contributor

@c-bata Could you review this PR?

Comment on lines +102 to +119
OptunaHub
---------

`OptunaHub <https://hub.optuna.org/>`__ is a platform for third-party packages designed for Optuna.
OptunaHub provides a collection of packages that are not included in the official Optuna distribution.
Users can also share their own packages on it.
You can check the official documentation of OptunaHub `here <https://optuna.github.io/optunahub/>`__.

.. image:: ../image/optunahub-introduction.png
:width: 800px

``optunahub`` can be installed via pip:

.. code-block:: console

$ pip install optunahub


Copy link
Copy Markdown
Contributor

@nabenabe0928 nabenabe0928 Jun 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about using the content in this section for consistency?

Copy link
Copy Markdown
Member

@c-bata c-bata left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM.

@nabenabe0928 Please use a "Squash and merge" option when merging this PR. This will prevent the original large image from being included in the git history (for faster git clone and pip install git+https://github.com/optuna/optuna.git).

@c-bata c-bata removed their assignment Jun 26, 2025
@c-bata c-bata added this to the v4.5.0 milestone Jun 26, 2025
Co-authored-by: Shuhei Watanabe <47781922+nabenabe0928@users.noreply.github.com>
@fusawa-yugo
Copy link
Copy Markdown
Contributor Author

Thank you for your reviews!!
I fixed them.

Copy link
Copy Markdown
Contributor

@nabenabe0928 nabenabe0928 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the updates, LGTM!

@nabenabe0928 nabenabe0928 enabled auto-merge (squash) June 26, 2025 09:36
@nabenabe0928 nabenabe0928 merged commit ec7fd81 into optuna:master Jun 26, 2025
14 checks passed
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

Successfully merging this pull request may close these issues.

3 participants