init: code skeleton + project goals in readme

artefactory · Sep 1, 2020 · dc5a6d6 · dc5a6d6
1 parent b8218c6
commit dc5a6d6
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,12 @@
 # one-click-mlflow
 A tool to deploy a mostly serverless MLflow on a GCP project with one command
+
+## Goals
+
+The project's deliverables are
+- MLflow tracking server on Cloud Run
+- Artifacts on GCS
+- Metrics backend on Cloud SQL (MySQL)
+- Terraformed infrastructure
+- A list of all the GCP APIs that need to be enabled
+- A list of all the necessary GCP permissions to run the deployment
diff --git a/bin/one-click-mlflow.py b/bin/one-click-mlflow.py
@@ -0,0 +1,2 @@
+from lib.entrypoint import run
+
diff --git a/config.py b/config.py
diff --git a/lib/__init__.py b/lib/__init__.py
diff --git a/lib/entrypoint.py b/lib/entrypoint.py
@@ -0,0 +1,2 @@
+def run():
+    raise NotImplementedError()
diff --git a/secrets/.keep b/secrets/.keep