chore: update env variables and documentation (#250)

* ODTP_DASHBOARD_JSON_EDITOR is no longer used
* ALLOW_DOCKER_GPUS is new to allow or disallow GPU flag in docker run

Co-authored-by: sabinem <[email protected]>

Author: sabinem

.env.dist.compose

@@ -43,8 +43,5 @@ ODTP_LOG_LEVEL=ERROR
 # Log Level when running executions
 RUN_LOG_LEVEL=INFO
 
-# App Path
-APP_PATH=
-
-# Install the package in editable mode.
-PIP_INSTALL_ARGS="--editable"
+# set to False if your docker installation does not allow the flag --gpus all
+ALLOW_DOCKER_GPUS=False

.env.dist.compose.dev

@@ -49,3 +49,6 @@ APP_PATH=
 
 # Install the package in editable mode.
 PIP_INSTALL_ARGS="--editable"
+
+# set to False if your docker installation does not allow the flag --gpus all
+ALLOW_DOCKER_GPUS=False

.env.dist.local

@@ -37,3 +37,6 @@ ODTP_LOG_LEVEL=ERROR
 
 # Log Level when running executions
 RUN_LOG_LEVEL=INFO
+
+# set to False if your docker installation does not allow the flag --gpus all
+ALLOW_DOCKER_GPUS=False

compose.dev.yml

@@ -27,7 +27,6 @@ services:
       ODTP_MONGO_DB: ${ODTP_MONGO_DB}
       ODTP_DASHBOARD_PORT: ${ODTP_DASHBOARD_PORT}
       ODTP_DASHBOARD_RELOAD: ${ODTP_DASHBOARD_RELOAD}
-      ODTP_DASHBOARD_JSON_EDITOR: ${ODTP_DASHBOARD_JSON_EDITOR}
       ODTP_LOG_LEVEL: ${ODTP_LOG_LEVEL}
       RUN_LOG_LEVEL: ${RUN_LOG_LEVEL}
       ALLOW_DOCKER_GPUS: ${ALLOW_DOCKER_GPUS:-True}

compose.yml

@@ -22,9 +22,9 @@ services:
       ODTP_PASSWORD: ${ODTP_PASSWORD}
       ODTP_MONGO_DB: ${ODTP_MONGO_DB}
       ODTP_DASHBOARD_PORT: ${ODTP_DASHBOARD_PORT}
-      ODTP_DASHBOARD_JSON_EDITOR: ${ODTP_DASHBOARD_JSON_EDITOR}
       ODTP_LOG_LEVEL: ${ODTP_LOG_LEVEL}
       RUN_LOG_LEVEL: ${RUN_LOG_LEVEL}
+      ALLOW_DOCKER_GPUS: ${ALLOW_DOCKER_GPUS:-True}
 
     stdin_open: true
     tty: true

odtp/helpers/settings.py

@@ -40,12 +40,6 @@ class OdtpSettingsException(Exception):
 else:
     ODTP_DASHBOARD_RELOAD = False
 
-ODTP_DASHBOARD_JSON_EDITOR = os.getenv("ODTP_DASHBOARD_JSON_EDITOR")
-if ODTP_DASHBOARD_JSON_EDITOR in ["False", "True"]:
-    ODTP_DASHBOARD_JSON_EDITOR = eval(ODTP_DASHBOARD_JSON_EDITOR)
-else:
-    ODTP_DASHBOARD_JSON_EDITOR = False
-
 ODTP_PATH = os.getenv("ODTP_PATH")
 
 ODTP_LOG_LEVEL = os.getenv("ODTP_LOG_LEVEL")