diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index 4b081a86..2490c8be 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -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 diff --git a/README.md b/README.md index debcf429..f517aa69 100644 --- a/README.md +++ b/README.md @@ -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: -## 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 ``` +
+MySQL (PyMySQL) + ``` -# MySQL (PyMySQL) $ docker run -it --rm -p 8080:8080 ghcr.io/optuna/optuna-dashboard mysql+pymysql://username:password@hostname:3306/dbname ``` +
+ +
+PostgreSQL (Psycopg2) + ``` -# 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 +
## Features