Update README

This commit is contained in:
c-bata
2020-10-24 18:53:42 +09:00
parent 241fb411d8
commit 58dd714cef
3 changed files with 69 additions and 2 deletions
+21
View File
@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2020 Masashi SHIBATA
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+1
View File
@@ -0,0 +1 @@
include LICENSE
+47 -2
View File
@@ -1,4 +1,49 @@
# optuna-dashboard
Web dashboard for Optuna.
TypeScript files originally taken from [Goptuna's dashboard](https://github.com/c-bata/goptuna).
Realtime Web dashboard for Optuna. Code files were originally taken from [Goptuna](https://github.com/c-bata/goptuna).
![demo](https://user-images.githubusercontent.com/5564044/97078684-ba98a180-1628-11eb-8245-7cb8c76647f5.gif)
## Usage
You can install optuna-dashboard via pip.
```console
$ pip install optuna-dashboard
```
After you installed, `optuna-dashboard` command is available.
Please execute it with Optuna storage URL.
```
$ optuna-dashboard sqlite:///db.sqlite3
Bottle v0.12.18 server starting up (using WSGIRefServer())...
Listening on http://localhost:8080/
Hit Ctrl-C to quit.
```
<details>
<summary>More command line options</summary>
```
$ optuna-dashboard --help
usage: optuna-dashboard [-h] [--port PORT] [--host HOST] [--quiet] storage
A third-party dashboard for optuna.
positional arguments:
storage Optuna Storage URL
optional arguments:
-h, --help show this help message and exit
--port PORT port number (default: 8080)
--host HOST hostname (default: 'localhost')
--quiet quiet
```
</details>
## Alternatives
* [optdash](https://github.com/ytsmiling/optdash): a third-party dashboard for optuna.