Update README

This commit is contained in:
c-bata
2020-10-25 16:25:00 +09:00
parent 57d38b9795
commit 19b05e6fa7
3 changed files with 13 additions and 13 deletions
+11 -11
View File
@@ -1,6 +1,6 @@
# optuna-dashboard
Web dashboard for Optuna. Code files were originally taken from [Goptuna](https://github.com/c-bata/goptuna).
Real-time dashboard for Optuna. Code files were originally taken from [Goptuna](https://github.com/c-bata/goptuna).
## Usage
@@ -22,13 +22,13 @@ Hit Ctrl-C to quit.
<details>
<summary>More command line options</summary>
<summary>more command line options</summary>
```console
$ optuna-dashboard -h
usage: optuna-dashboard [-h] [--port PORT] [--host HOST] [--version] [--quiet] storage
Web dashboard for optuna.
Real-time dashboard for Optuna.
positional arguments:
storage Optuna Storage URL
@@ -45,9 +45,15 @@ optional arguments:
## Features
### Interactive realtime graphs
### Create and delete study
You can check graphs of optimization history, parallel coordinate and intermediate values.
You can create and delete a study from Dashboard.
![optuna-create-delete-study](https://user-images.githubusercontent.com/5564044/97099702-4107be80-16cf-11eb-9d97-f5ceec98ce52.gif)
### Interactive live-updating graphs
Interactive live-updating graphs for optimization history, parallel coordinate and intermediate values.
![optuna-realtime-graph](https://user-images.githubusercontent.com/5564044/97099797-66e19300-16d0-11eb-826c-6977e3941fb0.gif)
@@ -57,12 +63,6 @@ You can walk-through trials with filtering and sorting.
![optuna-trial-table](https://user-images.githubusercontent.com/5564044/97099599-36005e80-16ce-11eb-929c-8498f6ea09da.gif)
### Create and delete study
You can create and delete a study from Dashboard.
![optuna-create-delete-study](https://user-images.githubusercontent.com/5564044/97099702-4107be80-16cf-11eb-9d97-f5ceec98ce52.gif)
## Alternatives
* [optdash](https://github.com/ytsmiling/optdash): a third-party dashboard for optuna.
+1 -1
View File
@@ -6,7 +6,7 @@ from .version import __version__
def main():
parser = argparse.ArgumentParser(description="Web dashboard for optuna.")
parser = argparse.ArgumentParser(description="Real-time dashboard for Optuna.")
parser.add_argument("storage", help="Optuna Storage URL", type=str)
parser.add_argument(
"--port", help="port number (default: %(default)s)", type=int, default=8080
+1 -1
View File
@@ -25,7 +25,7 @@ def get_version():
setup(
name="optuna-dashboard",
version=get_version(),
description="Web dashboard for Optuna.",
description="Real-time dashboard for Optuna.",
long_description=get_long_description(),
long_description_content_type="text/markdown",
author="Masashi Shibata",