From df21790b66b4b010d4f1aeed79c95b9574902255 Mon Sep 17 00:00:00 2001 From: c-bata Date: Fri, 12 Jan 2024 13:13:11 +0900 Subject: [PATCH 1/2] Update docs to introduce code-server extension --- docs/getting-started.rst | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/getting-started.rst b/docs/getting-started.rst index d3b040c6..46503bac 100644 --- a/docs/getting-started.rst +++ b/docs/getting-started.rst @@ -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 `_. +You can install the VS Code extension via `Visual Studio Marketplace `_, +or install the code-server extension via `Open VSX `_. .. 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 Date: Fri, 12 Jan 2024 16:01:23 +0900 Subject: [PATCH 2/2] Update README --- README.md | 8 ++++++-- docs/getting-started.rst | 4 ++-- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 13022125..2a2ee515 100644 --- a/README.md +++ b/README.md @@ -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). 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). diff --git a/docs/getting-started.rst b/docs/getting-started.rst index 46503bac..3ec69b1d 100644 --- a/docs/getting-started.rst +++ b/docs/getting-started.rst @@ -228,8 +228,8 @@ or install the code-server extension via `Open VSX