Skip to content

Latest commit

 

History

History
47 lines (42 loc) · 2.01 KB

File metadata and controls

47 lines (42 loc) · 2.01 KB

Dreem

Folder structure

We should all keep the same folder structure, and everybody works on different files on his branch.

When we want to push something to master, follow this guide to selectively merge files.

├── README.md          <- The top-level README for developers using this project.
│   
├── data
│   ├── interim        <- Intermediate data that has been transformed.
│   ├── processed      <- The final, canonical data sets for modeling.
│   └── raw            <- The original, immutable data dump.
│
├── docs               <- Reports, roadmap, TODOs, etc
│
├── 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-raph-initial-data-exploration`.
│
├── references         <- Papers and stuff
│
├── plots              <- Generated graphics and figures to be used in reporting
│
│
└── src                <- Source code for use in this project.
    ├── __init__.py    <- It's an empty file, makes src a Python module so that you can `from src import function`
    │
    ├── features       <- Scripts to turn raw data into features for modeling
    │   └── build_features.py
    │
    ├── hpsearch       <- Scripts to automatically search hyperparameters
    │   └── random_search.py
    │   
    ├── models         <- Scripts to train generic 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