Skip to content

Commit

Permalink
Merge pull request #48 from toshihikoyanase/add-next-action-to-usage
Browse files Browse the repository at this point in the history
Add next actions at the end of usage.
  • Loading branch information
HideakiImamura authored Aug 13, 2024
2 parents 87f0091 + 7225027 commit dc4f831
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Welcome to OptunaHub's documentation!
=====================================

`OptunaHub <https://hub.optuna.org/>`__ is a registry of third-party Optuna packages.
`OptunaHub <https://hub.optuna.org/>`__ is a registry of third-party packages designed for `Optuna <https://optuna.org>`__.
It allows users to share and discover Optuna packages that are not included in the official Optuna distribution.
The `optunahub <https://github.com/optuna/optunahub/>`_ library provides Python APIs to load and use packages from the OptunaHub registry.

Expand All @@ -15,7 +15,7 @@ Install the `optunahub`_ package.
pip install optunahub
Load the package you want from the OptunaHub registry as follows.
Load the package you want from the OptunaHub registry. In the next example code, you will load the ``SimulatedAnnealingSampler`` from the `samplers/simulated_annealing <https://hub.optuna.org/samplers/simulated_annealing/>`__ package.

.. code-block:: python
Expand All @@ -37,6 +37,9 @@ Load the package you want from the OptunaHub registry as follows.
print(study.best_trial.value, study.best_trial.params)
Now that you've successfully loaded a package from the OptunaHub registry, you can start using `optunahub`_ in your optimization!
Get ready to explore the most suitable packages for your problems in the `OptunaHub registry <https://hub.optuna.org/>`_.

.. toctree::
:maxdepth: 2
:caption: Contents:
Expand Down

0 comments on commit dc4f831

Please sign in to comment.