updates docs to reflect new directory structure; adds more general name to visualization directory

This commit is contained in:
Jordan Bramble 2016-04-27 00:25:27 -04:00
parent 3c345193bb
commit e69ae335a4
4 changed files with 18 additions and 14 deletions

View File

@ -70,7 +70,7 @@ Starting a new project is as easy as running this command at the command line. N
├── docs <- A default Sphinx project; see sphinx-doc.org for details
├── models <- trained and serialized models, model predictions, or model summaries
├── 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.
@ -93,10 +93,13 @@ Starting a new project is as easy as running this command at the command line. N
│   ├── 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
│   ├── models <- Scripts to train models and then use trained models to make
│ │ │ predictions
│   │   ├── predict_model.py
│   │   └── train_model.py
│ │
│   └── visualization <- Scripts to create exploratory and results oriented visualizations
│   └── visualize.py
└── tox.ini <- tox file with settings for running tox; see tox.testrun.org
```

View File

@ -17,7 +17,7 @@ Project Organization
├── docs <- A default Sphinx project; see sphinx-doc.org for details
├── models <- trained and serialized models, model predictions, or model summaries
├── 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.
@ -40,11 +40,12 @@ Project Organization
│   ├── 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
│   ├── models <- Scripts to train models and then use trained models to make
│ │ │ predictions
│   │   ├── predict_model.py
│   │   └── train_model.py
│ │
│   └── visualization <- Scripts to create exploratory and results oriented visualizations
│   └── visualize.py
└── tox.ini <- tox file with settings for running tox; see tox.testrun.org