From d85562b3f6ee6cae3f2fbcf15239ea7d7b37169c Mon Sep 17 00:00:00 2001 From: c-bata Date: Wed, 30 Aug 2023 15:50:15 +0900 Subject: [PATCH] Update README and add ogp for optuna-dashboard-wasm --- .github/workflows/gh-pages.yml | 6 +----- README.md | 29 ++++++++++++++--------------- standalone_app/github-pages.html | 19 +++++++++++++++++++ 3 files changed, 34 insertions(+), 20 deletions(-) create mode 100644 standalone_app/github-pages.html diff --git a/.github/workflows/gh-pages.yml b/.github/workflows/gh-pages.yml index 84c0dbc3..311d606f 100644 --- a/.github/workflows/gh-pages.yml +++ b/.github/workflows/gh-pages.yml @@ -39,11 +39,7 @@ jobs: mkdir gh-publish cp -r standalone_app/public gh-publish/public cp standalone_app/favicon.ico gh-publish/favicon.ico - - name: Create index.html - run: | - cp standalone_app/index.html gh-publish/index.html - sed -i "s|/public/bundle.js|/optuna-dashboard/public/bundle.js|g" ./gh-publish/index.html - sed -i "s|/favicon.ico|/optuna-dashboard/favicon.ico|g" ./gh-publish/index.html + cp standalone_app/github-pages.html gh-publish/index.html - name: Upload artifact uses: actions/upload-pages-artifact@v2 with: diff --git a/README.md b/README.md index 4b38f863..6048d073 100644 --- a/README.md +++ b/README.md @@ -75,27 +75,26 @@ $ docker run -it --rm -p 8080:8080 ghcr.io/optuna/optuna-dashboard postgresql+ps +## Browser-only version (Experimental) + +Browser-only version + +We’ve developed the version that operates solely within your web browser, which internally uses SQLite3 Wasm and Rust. +There’s no need to install Python or any other dependencies. +Simply open the following URL in your browser, drag and drop your SQLite3 file onto the page, and you’re ready to view your Optuna studies! + +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) You can install the VS Code extension via [Visual Studio Marketplace](https://marketplace.visualstudio.com/items?itemName=Optuna.optuna-dashboard#overview). -![vscode-extension](./docs/_static/vscode-extension.png) +VSCode 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. - -## Features - -### Manage Studies - -You can create and delete studies from Dashboard. - -![optuna-dashboard-create-delete-study](https://user-images.githubusercontent.com/5564044/205545958-305f2354-c7cd-4687-be2f-9e46e7401838.gif) - -### Visualize with Interactive Graphs & Rich Trials Data Grid - -You can check the optimization history, hyperparameter importances, etc. in graphs and tables. - -![optuna-dashboard-realtime-graph](https://user-images.githubusercontent.com/5564044/205545965-278cd7f4-da7d-4e2e-ac31-6d81b106cada.gif) +This extension leverages the browser-only version of Optuna Dashboard, so the same limitations apply. ## Submitting patches diff --git a/standalone_app/github-pages.html b/standalone_app/github-pages.html new file mode 100644 index 00000000..609c5c30 --- /dev/null +++ b/standalone_app/github-pages.html @@ -0,0 +1,19 @@ + + + + + Optuna Dashboard (Wasm ver.) + + + + + + + + + + + +
+ +