diff --git a/docs/api.rst b/docs/api.rst index 711f4e441..3cb88c57b 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -12,9 +12,9 @@ General APIs optuna_dashboard.run_server optuna_dashboard.wsgi - optuna_dashboard.set_objective_names optuna_dashboard.save_note optuna_dashboard.save_plotly_graph_object + optuna_dashboard.artifact.get_artifact_path Human-in-the-loop ----------------- @@ -57,19 +57,3 @@ Streamlit optuna_dashboard.streamlit.render_trial_note optuna_dashboard.streamlit.render_objective_form_widgets optuna_dashboard.streamlit.render_user_attr_form_widgets - -Artifact --------- - -.. autosummary:: - :toctree: _generated/ - :nosignatures: - - optuna_dashboard.artifact.upload_artifact - optuna_dashboard.artifact.get_artifact_path - optuna_dashboard.artifact.file_system.FileSystemBackend - optuna_dashboard.artifact.boto3.Boto3Backend - optuna_dashboard.artifact.backoff.Backoff - optuna_dashboard.artifact.prefix.AppendPrefix - optuna_dashboard.artifact.protocol.ArtifactBackend - optuna_dashboard.artifact.exceptions.ArtifactNotFound diff --git a/docs/errors.rst b/docs/errors.rst index dd78d7674..87dd47d80 100644 --- a/docs/errors.rst +++ b/docs/errors.rst @@ -27,7 +27,7 @@ or use a following dirty hack to unwrap ``_CachedStorage`` class. ``set_objective_names()`` function is deprecated. Please use ``study.set_metric_names()`` instead. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:func:`~optuna_dashboard.set_objective_names` function has been ported to Optuna. +``set_objective_names`` function has been ported to Optuna. Please use `study.set_metric_names() `_ function instead. .. list-table:: @@ -41,7 +41,7 @@ Please use `study.set_metric_names() `_ function instead. .. list-table:: @@ -57,7 +57,7 @@ Please note that the order of arguments is different between the deprecated and ``FileSystemBackend`` is deprecated. Please use ``FileSystemArtifactStore`` instead. ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -:class:`~optuna_dashboard.artifact.file_system.FileSystemBackend` class has been ported to Optuna. +``FileSystemBackend`` class has been ported to Optuna. Please use `FileSystemArtifactStore `_ class instead. .. list-table:: @@ -71,7 +71,7 @@ Please use `FileSystemArtifactStore `_ class instead. .. list-table::