From e3d2c34c36d6c980ae13171584080747adc680f6 Mon Sep 17 00:00:00 2001
From: Herbie Bradley <mail@herbiebradley.com>
Date: Mon, 10 Dec 2018 19:59:18 +0000
Subject: [PATCH] Update readme filetree

---
 README.md | 46 +++++++++++++++++++++-------------------------
 1 file changed, 21 insertions(+), 25 deletions(-)

diff --git a/README.md b/README.md
index df023f2..83e1e1b 100644
--- a/README.md
+++ b/README.md
@@ -20,42 +20,38 @@ Project Organization
     │   ├── processed      <- The final, canonical data sets for modeling.
     │   └── raw            <- The original, immutable data dump.
     │
-    ├── docs               <- A default Sphinx project; see sphinx-doc.org for details
-    │
     ├── models             <- Trained and serialized models, model predictions, or model summaries
     │
-    ├── notebooks          <- Jupyter notebooks. Naming convention is a number (for ordering),
-    │                         the creator's initials, and a short `-` delimited description, e.g.
-    │                         `1.0-jqp-initial-data-exploration`.
+    ├── notebooks          <- Jupyter notebooks.
     │
     ├── references         <- Data dictionaries, manuals, and all other explanatory materials.
     │
     ├── reports            <- Generated analysis as HTML, PDF, LaTeX, etc.
     │   └── figures        <- Generated graphics and figures to be used in reporting
     │
-    ├── requirements.txt   <- The requirements file for reproducing the analysis environment, e.g.
+    ├── requirements.yml   <- The requirements file for reproducing the analysis environment, e.g.
     │                         generated with `pip freeze > requirements.txt`
     │
     ├── setup.py           <- makes project pip installable (pip install -e .) so src can be imported
-    ├── src                <- Source code for use in this project.
-    │   ├── __init__.py    <- Makes src a Python module
-    │   │
-    │   ├── data           <- Scripts to download or generate data
-    │   │   └── make_dataset.py
-    │   │
-    │   ├── features       <- Scripts to turn raw data into features for modeling
-    │   │   └── build_features.py
-    │   │
-    │   ├── models         <- Scripts to train models and then use trained models to make
-    │   │   │                 predictions
-    │   │   ├── predict_model.py
-    │   │   └── train_model.py
-    │   │
-    │   └── utils  <- Utility files, including scripts for visualisation
-    │       └── visualize.py
-    │
-    └── tox.ini            <- tox file with settings for running tox; see tox.testrun.org
-
+    └── src                <- Source code for use in this project.
+        ├── __init__.py    <- Makes src a Python module
+        │
+        ├── train.py       <- Run this to train.
+        │
+        ├── test.py        <- Run this to test.
+        │
+        ├── pipeline       <- Code for downloading or loading data  
+        │   ├── data.py
+        │   └── download_data.py
+        │
+        ├── options       <- Files for command line options
+        │   └── base_options.py
+        │
+        ├── models         <- Code for defining the network structure and loss functions
+        │   ├── network.py
+        │   └── losses.py
+        │
+        └── utils  <- Utility files, including scripts for visualisation
 
 --------