Browse Source

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

main
Jordan Bramble 9 years ago
parent
commit
e69ae335a4
  1. 15
      docs/docs/index.md
  2. 17
      {{ cookiecutter.repo_name }}/README.md
  3. 0
      {{ cookiecutter.repo_name }}/src/visualization/.gitkeep
  4. 0
      {{ cookiecutter.repo_name }}/src/visualization/visualize.py

15
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 ├── 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), ├── notebooks <- Jupyter notebooks. Naming convention is a number (for ordering),
│ the creator's initials, and a short `-` delimited description, e.g. │ 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    ├── features <- Scripts to turn raw data into features for modeling
     └── build_features.py      └── build_features.py
│ │ │ │
   └── models <- scripts to train models and then use trained models to make    ├── models <- Scripts to train models and then use trained models to make
│ │ predictions │ │ │ predictions
   ├── predict_model.py      ├── predict_model.py
   └── train_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 ## Opinions

17
{{ cookiecutter.repo_name }}/README.md

@ -17,7 +17,7 @@ Project Organization
├── docs <- A default Sphinx project; see sphinx-doc.org for details ├── 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), ├── notebooks <- Jupyter notebooks. Naming convention is a number (for ordering),
│ the creator's initials, and a short `-` delimited description, e.g. │ 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    ├── features <- Scripts to turn raw data into features for modeling
     └── build_features.py      └── build_features.py
│ │ │ │
   └── models <- scripts to train models and then use trained models to make    ├── models <- Scripts to train models and then use trained models to make
│ │ predictions │ │ │ predictions
   ├── predict_model.py      ├── predict_model.py
   └── train_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

0
{{ cookiecutter.repo_name }}/src/visualizations/.gitkeep → {{ cookiecutter.repo_name }}/src/visualization/.gitkeep

0
{{ cookiecutter.repo_name }}/src/visualizations/visualize_results.py → {{ cookiecutter.repo_name }}/src/visualization/visualize.py

Loading…
Cancel
Save