wassname/optuna-dashboard
1
0
Fork 0
mirror of https://github.com/wassname/optuna-dashboard.git synced 2026-09-11 12:30:25 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #789 from c-bata/remove-deprecated-features-from-doc

Browse Source 
Remove deprecated artifact features from API document
This commit is contained in:
c-bata
2024-01-31 18:22:11 +09:00
committed by GitHub
parent bbf9b4a8ef 4235419a99
commit 390df14f2f
2 changed files with 5 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api.rst
+1 -17
View File
@@ -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
docs/errors.rst
+4 -4
View File
@@ -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() <https://optuna.readthedocs.io/en/latest/reference/generated/optuna.study.Study.html#optuna.study.Study>`_ function instead.
.. list-table::
@@ -41,7 +41,7 @@ Please use `study.set_metric_names() <https://optuna.readthedocs.io/en/latest/re
``upload_artifact()`` is deprecated. Please use ``optuna.artifacts.upload_artifact()`` instead.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:func:`~optuna_dashboard.artifact.upload_artifact` function has been ported to Optuna.
``upload_artifact`` function has been ported to Optuna.
Please use `optuna.artifacts.upload_artifact <https://optuna.readthedocs.io/en/latest/reference/generated/optuna.artifacts.upload_artifact.html>`_ 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 <https://optuna.readthedocs.io/en/latest/reference/generated/optuna.artifacts.FileSystemArtifactStore.html>`_ class instead.
.. list-table::
@@ -71,7 +71,7 @@ Please use `FileSystemArtifactStore <https://optuna.readthedocs.io/en/latest/ref
``Boto3Backend``` is deprecated. Please use ``Boto3ArtifactStore`` instead.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:class:`~optuna_dashboard.artifact.boto3.Boto3Backend` class has been ported to Optuna.
``Boto3Backend`` class has been ported to Optuna.
Please use `Boto3ArtifactStore <https://optuna.readthedocs.io/en/latest/reference/generated/optuna.artifacts.Boto3ArtifactStore.html>`_ class instead.
.. list-table::