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

Update README and add ogp for optuna-dashboard-wasm

Browse Source
This commit is contained in:
c-bata
2023-08-30 15:50:15 +09:00
parent fff051d32f
commit d85562b3f6
3 changed files with 34 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.github/workflows/gh-pages.yml
+1 -5
View File
@@ -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:
README.md
+14 -15
View File
@@ -75,27 +75,26 @@ $ docker run -it --rm -p 8080:8080 ghcr.io/optuna/optuna-dashboard postgresql+ps
</details>
## Browser-only version (Experimental)
<img src="./docs/_static/browser-app.gif" style="width:600" alt="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)
<img src="./docs/_static/vscode-extension.png" style="width:600" alt="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
standalone_app/github-pages.html
+19
View File
@@ -0,0 +1,19 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>Optuna Dashboard (Wasm ver.)</title>
<script defer type="module" src="/optuna-dashboard/public/bundle.js"></script>
<link rel="icon" href="/optuna-dashboard/favicon.ico" />
<!-- ogp -->
<meta property="og:title" content="Optuna Dashboard (Wasm ver.)" />
<meta property="og:type" content="website" />
<meta property="og:url" content="https://optuna.github.io/optuna-dashboard/" />
<meta property="og:image" content="/img/ogp_image.png" />
<meta property="og:description" content="Web Dashboard for Optuna, Python library for hyperparameter optimization" />
</head>
<body>
<div id="root"></div>
</body>
</html>