add readme and make install.

This commit is contained in:
Matt J 2022-11-05 07:57:52 -07:00
parent a288a8e1e2
commit 404e39206b
3 changed files with 41 additions and 1 deletions

View File

@ -1,4 +1,8 @@
all: CONDA_ENV=ml_pipeline
all: run
run:
python src/pipeline.py train python src/pipeline.py train
data: data:
@ -6,3 +10,6 @@ data:
batch: batch:
python src/batch.py python src/batch.py
install:
conda env updates -n ${CONDA_ENV} --file environment.yml

33
README.md Normal file
View File

@ -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
```

0
src/model/__init__.py Normal file
View File