wassname/optuna-dashboard
1
0
Fork 0
mirror of https://github.com/wassname/optuna-dashboard.git synced 2026-09-11 12:30:25 +08:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #159 from optuna/update-docker-description

Browse Source 
Update the usage of docker image
This commit is contained in:
Masashi Shibata
2021-12-31 14:32:18 +09:00
committed by GitHub
parent b33c30e6a5 e70540ead9
commit 7f7dd58a08
2 changed files with 16 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files
DEVELOPMENT.md
+1 -11
View File
@@ -40,17 +40,7 @@ You can use the Docker image like below:
```
# SQLite3
$ docker run -it --rm -p 8080:8080 -v `PWD`:/app optuna-dashboard sqlite:///db.sqlite3
```
```
# MySQL (PyMySQL)
$ docker run -it --rm -p 8080:8080 optuna-dashboard mysql+pymysql://username:password@hostname:3306/dbname
```
```
# PostgreSQL (Psycopg2)
$ docker run -it --rm -p 8080:8080 optuna-dashboard postgresql+psycopg2://username:password@hostname:5432/dbname
$ docker run -it --rm -p 8080:8080 -v `PWD`:/app -w /app optuna-dashboard sqlite:///db.sqlite3
```
### Running dashboard server
README.md
+15 -9
View File
@@ -6,7 +6,7 @@
Real-time dashboard for [Optuna](https://github.com/optuna/optuna).
Code files were originally taken from [Goptuna](https://github.com/c-bata/goptuna).
## Usage
## Getting Started
You can install optuna-dashboard via [PyPI](https://pypi.org/project/optuna-dashboard/) or [Anaconda Cloud](https://anaconda.org/conda-forge/optuna-dashboard).
@@ -53,27 +53,33 @@ optional arguments:
</details>
## Usage (Docker)
## Using an official Docker image
You can also use a Docker image to run optuna-dashboard.
The image only supports SQLite3, MySQL(PyMySQL), and PostgreSQL(Psycopg2).
You can also use [an official Docker image](https://github.com/optuna/optuna-dashboard/pkgs/container/optuna-dashboard) instead of setting up your Python environment.
The Docker image only supports SQLite3, MySQL(PyMySQL), and PostgreSQL(Psycopg2).
```
# SQLite3
$ docker run -it --rm -p 8080:8080 -v `PWD`:/app ghcr.io/optuna/optuna-dashboard sqlite:///db.sqlite3
$ docker run -it --rm -p 8080:8080 -v `PWD`:/app -w /app \
> ghcr.io/optuna/optuna-dashboard sqlite:///db.sqlite3
```
<details>
<summary>MySQL (PyMySQL)</summary>
```
# MySQL (PyMySQL)
$ docker run -it --rm -p 8080:8080 ghcr.io/optuna/optuna-dashboard mysql+pymysql://username:password@hostname:3306/dbname
```
</details>
<details>
<summary>PostgreSQL (Psycopg2)</summary>
```
# PostgreSQL (Psycopg2)
$ docker run -it --rm -p 8080:8080 ghcr.io/optuna/optuna-dashboard postgresql+psycopg2://username:password@hostname:5432/dbname
```
https://github.com/optuna/optuna-dashboard/pkgs/container/optuna-dashboard
</details>
## Features