.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "recipes/005_debugging.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_recipes_005_debugging.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_recipes_005_debugging.py:


.. _debugging:

How to Debug Your Algorithm Before Registering in OptunaHub
===========================================================

This recipe shows how to debug your package before registering it in OptunaHub.


Load Your Package from Local Directory
-----------------------------------------------------------

First, you can use the `optunahub.load_local_module <https://optuna.github.io/optunahub/reference.html#optunahub.load_local_module>`__ function to load your package from your local directory and check if it works correctly.

.. code-block:: python

    import optunahub

    module = optunahub.load_local_module(
        package="category/your_package_name",
        registry_root="/path/to/optunahub-registry/package",
    )


Load Your Package from Your Fork of The optunahub-registry Repository
---------------------------------------------------------------------

Second, you can use the `optunahub.load_module <https://optuna.github.io/optunahub/reference.html#optunahub.load_module>`__ function with ``repo_owner={YOUR_GITHUB_ID}`` and ``ref={YOUR_BRANCH_NAME}`` to load your package from your fork of the optunahub-registry repository and check if it works correctly.

.. code-block:: python

    import optunahub

    module = optunahub.load_module(
        package="category/your_package_name",
        repo_owner="your_github_id",
        ref="your_branch_name",
    )


.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (0 minutes 0.000 seconds)


.. _sphx_glr_download_recipes_005_debugging.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: 005_debugging.ipynb <005_debugging.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: 005_debugging.py <005_debugging.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: 005_debugging.zip <005_debugging.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_