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

Document artifact warnings

Browse Source
This commit is contained in:
c-bata
2023-08-09 16:01:31 +09:00
parent 92083b0011
commit 84577b8ff3
4 changed files with 48 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/errors.rst
+43
View File
@@ -37,3 +37,46 @@ Please use `study.set_metric_names() <https://optuna.readthedocs.io/en/latest/re
* - ``optuna_dashboard.set_objective_names(study, ["objective 1", "objective 2"])``
- ``study.set_metric_names(["objective 1", "objective 2"])``
``upload_artifact()`` is deprecated. Please use ``optuna.artifacts.upload_artifact()`` instead.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:func:`~optuna_dashboard.artifact.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::
* - Deprecated APIs
- Corresponding Active APIs
* - ``optuna_dashboard.artifact.upload_artifact(artifact_backend, trial, fiel_path)``
- ``optuna.artifacts.upload_artifact(trial, file_path, artifact_store)``
Please note that the order of arguments is different between the deprecated and active APIs.
``FileSystemBackend`` is deprecated. Please use ``FileSystemArtifactStore`` instead.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:class:`~optuna_dashboard.artifact.file_system.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::
* - Deprecated APIs
- Corresponding Active APIs
* - ``optuna_dashboard.artifact.file_system.FileSystemBackend(base_path)``
- ``optuna.artifacts.FileSystemArtifactStore(base_path)``
``Boto3Backend``` is deprecated. Please use ``Boto3ArtifactStore`` instead.
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
:class:`~optuna_dashboard.artifact.boto3.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::
* - Deprecated APIs
- Corresponding Active APIs
* - ``optuna_dashboard.artifact.boto3.Boto3Backend(bucket_name, client=None)``
- ``optuna.artifacts.Boto3ArtifactStore(bucket_name, client=None)``
optuna_dashboard/artifact/_backend.py
+2 -3
View File
@@ -161,9 +161,8 @@ def upload_artifact(
return ...
"""
warnings.warn(
"This function is deprecated. Please use optuna.artifacts.upload_artifact() instead.\n"
"See https://optuna.readthedocs.io/en/latest/reference/generated/"
"optuna.artifacts.upload_artifact.html",
"upload_artifact() is deprecated. Please use optuna.artifacts.upload_artifact() instead.\n"
"See https://optuna-dashboard.readthedocs.io/en/latest/errors.html for details",
DeprecationWarning,
)
optuna_dashboard/artifact/boto3.py
+2 -3
View File
@@ -52,9 +52,8 @@ class Boto3Backend:
# See https://github.com/boto/boto3/issues/929
self._avoid_buf_copy = avoid_buf_copy
warnings.warn(
"Boto3Backend is deprecated. Please use optuna.artifacts.Boto3ArtifactStore instead.\n"
"See https://optuna.readthedocs.io/en/latest/reference/generated/optuna.artifacts."
"Boto3ArtifactStore.html",
"Boto3Backend is deprecated. Please use Boto3ArtifactStore instead.\n"
"See https://optuna-dashboard.readthedocs.io/en/latest/errors.html for details",
DeprecationWarning,
)
optuna_dashboard/artifact/file_system.py
+1 -2
View File
@@ -41,8 +41,7 @@ class FileSystemBackend:
self._base_path = base_path
warnings.warn(
"FileSystemBackend is deprecated. Please use FileSystemArtifactStore instead.\n"
"See https://optuna.readthedocs.io/en/latest/reference/generated/optuna.artifacts."
"FileSystemArtifactStore.html",
"See https://optuna-dashboard.readthedocs.io/en/latest/errors.html for details",
DeprecationWarning,
)