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

Merge pull request #750 from c-bata/doc-code-server

Browse Source 
Update docs to introduce code-server extension
This commit is contained in:
Hideaki Imamura
2024-01-19 13:21:29 +09:00
committed by GitHub
parent 2197e7966a 0997b61935
commit 49ea3ab3f3
2 changed files with 12 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+6 -2
View File
@@ -102,15 +102,19 @@ https://optuna.github.io/optuna-dashboard/
*Please note that only a subset of features is available. However, you can still check the optimization history, hyperparameter importances, and etc. in graphs and tables.*
## VS Code Extension (Experimental)
## VS Code and code-server Extension (Experimental)
You can install the VS Code extension via [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=Optuna.optuna-dashboard#overview).
You can install the VS Code extension via [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=Optuna.optuna-dashboard#overview),
or install the code-server extension via [Open VSX](https://open-vsx.org/extension/Optuna/optuna-dashboard).
<img src="./docs/_static/vscode-extension.png" style="width:600px;" alt="VS Code Extension">
Please right-click the SQLite3 files (`*.db` or `*.sqlite3`) in the VS Code file explorer and select the "Open in Optuna Dashboard" command from the dropdown menu.
This extension leverages the browser-only version of Optuna Dashboard, so the same limitations apply.
Please note that we have confirmed the behavior of the code-server extension can be unstable.
When opening SQLite files, the dashboard may not appear on the first attempt, but it should be displayed upon a second try.
## Submitting patches
If you want to contribute, please check [Developers Guide](./CONTRIBUTING.md).
docs/getting-started.rst
+6 -3
View File
@@ -212,10 +212,11 @@ https://optuna.github.io/optuna-dashboard/
Currently, only a subset of features is available. However, you can still check the optimization history, hyperparameter importances, and etc. in graphs and tables.
VS Code Extension (Experimental)
--------------------------------
VS Code and code-server Extension (Experimental)
------------------------------------------------
You can install the VS Code extension via `Visual Studio Marketplace <https://marketplace.visualstudio.com/items?itemName=Optuna.optuna-dashboard#overview>`_.
You can install the VS Code extension via `Visual Studio Marketplace <https://marketplace.visualstudio.com/items?itemName=Optuna.optuna-dashboard#overview>`_,
or install the code-server extension via `Open VSX <https://open-vsx.org/extension/Optuna/optuna-dashboard>`_.
.. figure:: _static/vscode-extension.png
:alt: Screenshot for the VS Code Extension
@@ -227,6 +228,8 @@ You can install the VS Code extension via `Visual Studio Marketplace <https://ma
To use, right-click the SQLite3 files (``*.db`` or ``*.sqlite3``) in the file explorer and select the "Open in Optuna Dashboard" from the dropdown menu.
This extension leverages the browser-only version of Optuna Dashboard, so the same limitations apply.
Please note that we have confirmed the behavior of the code-server extension can be unstable.
When opening SQLite files, the dashboard may not appear on the first attempt, but it should be displayed upon a second try.
Google Colaboratory
-------------------