From 404e39206b2557028eececaa8dad7484b8e6bc0d Mon Sep 17 00:00:00 2001
From: Matt J <mattjensen@fastmail.com>
Date: Sat, 5 Nov 2022 07:57:52 -0700
Subject: [PATCH] add readme and make install.

---
 Makefile              |  9 ++++++++-
 README.md             | 33 +++++++++++++++++++++++++++++++++
 src/model/__init__.py |  0
 3 files changed, 41 insertions(+), 1 deletion(-)
 create mode 100644 README.md
 create mode 100644 src/model/__init__.py

diff --git a/Makefile b/Makefile
index 0f26387..334c298 100644
--- a/Makefile
+++ b/Makefile
@@ -1,4 +1,8 @@
-all:
+CONDA_ENV=ml_pipeline
+
+all: run
+
+run:
 	python src/pipeline.py train
 
 data:
@@ -6,3 +10,6 @@ data:
 
 batch:
 	python src/batch.py
+
+install:
+	conda env updates -n ${CONDA_ENV} --file environment.yml
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..52c6a08
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+# Mimimal Viable Deep Learning Infrastructure
+
+Deep learning pipelines are hard to reason about and difficult to code consistently.
+
+Instead of remembering where to put everything and making a different choice for each project, this repository is an attempt to standardize on good defaults.
+
+Think of it like a mini-pytorch lightening, with all the fory internals exposed for extension and modification.
+
+
+## Usage
+
+### Install:
+
+Install the conda requirements:
+
+```bash
+make install
+```
+
+Which is a proxy for calling:
+
+```bash
+conda env updates -n ml_pipeline --file environment.yml
+```
+
+### Run:
+
+Run the code on MNIST with the following command:
+
+```bash
+make run
+```
+
diff --git a/src/model/__init__.py b/src/model/__init__.py
new file mode 100644
index 0000000..e69de29