diff --git a/docs/docs/index.md b/docs/docs/index.md index 198182e..3b29b3e 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -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,12 +93,15 @@ 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 +└── tox.ini <- tox file with settings for running tox; see tox.testrun.org ``` ## Opinions diff --git a/{{ cookiecutter.repo_name }}/README.md b/{{ cookiecutter.repo_name }}/README.md index 8ca70b4..0d9a104 100644 --- a/{{ cookiecutter.repo_name }}/README.md +++ b/{{ cookiecutter.repo_name }}/README.md @@ -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 - - + └── tox.ini <- tox file with settings for running tox; see tox.testrun.org diff --git a/{{ cookiecutter.repo_name }}/src/visualization/.gitkeep b/{{ cookiecutter.repo_name }}/src/visualization/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/{{ cookiecutter.repo_name }}/src/visualization/visualize.py b/{{ cookiecutter.repo_name }}/src/visualization/visualize.py new file mode 100644 index 0000000..e69de29