├── data
│   ├── external        <- Data from third party sources.
│   ├── interim         <- Intermediate data that has been transformed.
│   ├── processed       <- The final, canonical data sets for modeling.
│   └── raw             <- The original, immutable data dump.
|
├── database            <- MongoDB smarter database docker-composed image
│
├── 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`.
│
├── 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
│
├── src                 <- Source code for use in this project.
│   ├── __init__.py     <- Makes src a Python module
│   │
│   ├── data            <- Scripts to download or generate data
│   │
│   ├── features        <- Scripts to turn raw data into features for modeling
│   │
│   ├── 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
|
├── tests               <- Folder to test python modules / scripts
│
├── HISTORY.rst         <- Project change log
├── LICENSE             <- Project LICENSE
├── Makefile            <- Makefile with commands like `make data` or `make train`
├── README.md           <- The top-level README for developers using this project.
├── conda-linux-64.lock <- Conda environment lock file for linux 64 bit
├── environment.yml     <- Conda environment file
├── poetry.lock         <- Poetry lock file
├── pyproject.toml      <- Poetry project file
├── pytest.ini          <- Configuration file for `pytest` testing environment
├── setup.py            <- makes project pip installable (pip install -e .) so src can be imported
└── test_environment.py <- Helper script to test if environment is properly set