From 2605f0e1e71f8da70d057cd9acdb235db715249a Mon Sep 17 00:00:00 2001 From: c-bata Date: Wed, 29 Dec 2021 03:31:51 +0900 Subject: [PATCH] Fix a Docker image --- DEVELOPMENT.md | 15 +++++++++++++-- Dockerfile | 4 ++++ README.md | 8 ++++---- 3 files changed, 21 insertions(+), 6 deletions(-) diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index b334fd5d..4b081a86 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -32,14 +32,25 @@ $ npm run build:prd ### Building a Docker image ``` -$ docker build -t cbata/optuna-dashboard . +$ docker build -t optuna-dashboard . ``` When failed above command due to the out of heap memory error (Exit code: 137), please check "Resources" tab on your Docker engine's preference since it requires a lot of memory to compile TypeScript files. You can use the Docker image like below: ``` -$ docker run -it --rm -p 8080:8080 cbata/optuna-dashboard sqlite:///db.sqlite3 +# 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 ``` ### Running dashboard server diff --git a/Dockerfile b/Dockerfile index 4cd28c4d..1eb15b39 100644 --- a/Dockerfile +++ b/Dockerfile @@ -28,5 +28,9 @@ FROM python:3.8-slim-buster as runner COPY --from=python-builder /usr/local/lib/python3.8/site-packages /usr/local/lib/python3.8/site-packages COPY --from=python-builder /usr/local/bin/optuna-dashboard /usr/local/bin/optuna-dashboard +RUN mkdir /app +WORKDIR /app + EXPOSE 8080 ENTRYPOINT ["optuna-dashboard", "--port", "8080", "--host", "0.0.0.0"] + diff --git a/README.md b/README.md index 44a5c681..80f9ea65 100644 --- a/README.md +++ b/README.md @@ -8,15 +8,15 @@ Code files were originally taken from [Goptuna](https://github.com/c-bata/goptun ## Usage -You can install optuna-dashboard via [PyPI](https://pypi.org/project/optuna-dashboard/) or [conda-forge](https://anaconda.org/conda-forge/optuna-dashboard). +You can install optuna-dashboard via [PyPI](https://pypi.org/project/optuna-dashboard/) or [Anaconda Cloud](https://anaconda.org/conda-forge/optuna-dashboard). ``` +# PyPI $ pip install optuna-dashboard ``` -or - ``` +# Anaconda Cloud $ conda install -c conda-forge optuna-dashboard ``` @@ -31,7 +31,7 @@ Hit Ctrl-C to quit.
-more command line options +More command line options ```console $ optuna-dashboard -h