From 3c345193bbd632b5f9255064dc9044c23aca3542 Mon Sep 17 00:00:00 2001 From: Jordan Bramble Date: Tue, 26 Apr 2016 17:35:07 -0400 Subject: [PATCH 1/2] adds visualization directory to src --- {{ cookiecutter.repo_name }}/src/visualizations/.gitkeep | 0 .../src/visualizations/visualize_results.py | 0 2 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 {{ cookiecutter.repo_name }}/src/visualizations/.gitkeep create mode 100644 {{ cookiecutter.repo_name }}/src/visualizations/visualize_results.py diff --git a/{{ cookiecutter.repo_name }}/src/visualizations/.gitkeep b/{{ cookiecutter.repo_name }}/src/visualizations/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/{{ cookiecutter.repo_name }}/src/visualizations/visualize_results.py b/{{ cookiecutter.repo_name }}/src/visualizations/visualize_results.py new file mode 100644 index 0000000..e69de29 From e69ae335a49a61a898a7e844dd3d31549d5a1ae1 Mon Sep 17 00:00:00 2001 From: Jordan Bramble Date: Wed, 27 Apr 2016 00:25:27 -0400 Subject: [PATCH 2/2] updates docs to reflect new directory structure; adds more general name to visualization directory --- docs/docs/index.md | 15 +++++++++------ {{ cookiecutter.repo_name }}/README.md | 17 +++++++++-------- .../{visualizations => visualization}/.gitkeep | 0 .../visualize.py} | 0 4 files changed, 18 insertions(+), 14 deletions(-) rename {{ cookiecutter.repo_name }}/src/{visualizations => visualization}/.gitkeep (100%) rename {{ cookiecutter.repo_name }}/src/{visualizations/visualize_results.py => visualization/visualize.py} (100%) 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/visualizations/.gitkeep b/{{ cookiecutter.repo_name }}/src/visualization/.gitkeep similarity index 100% rename from {{ cookiecutter.repo_name }}/src/visualizations/.gitkeep rename to {{ cookiecutter.repo_name }}/src/visualization/.gitkeep diff --git a/{{ cookiecutter.repo_name }}/src/visualizations/visualize_results.py b/{{ cookiecutter.repo_name }}/src/visualization/visualize.py similarity index 100% rename from {{ cookiecutter.repo_name }}/src/visualizations/visualize_results.py rename to {{ cookiecutter.repo_name }}/src/visualization/visualize.py