Project Organization
βββ LICENSE
βββ Makefile <- Makefile with commands like `make dirs` or `make clean`
βββ README.md <- The top-level README for developers using this project.
βββ data
β βββ processed <- The final, canonical data sets for modeling.
β βββ raw <- The original, immutable data dump
β
βββ 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
β βββ metrics.txt <- Relevant metrics after evaluating the model.
β βββ training_metrics.txt <- Relevant metrics from training the model.
β
βββ requirements.txt <- The requirements file for reproducing the analysis environment, e.g.
β generated with `pip freeze > requirements.txt`
β
βββ setup.py <- makes project pip installable (pip install -e .) so src can be imported
βββ src <- Source code for use in this project.
β βββ __init__.py <- Makes src a Python module
β β
β βββ data <- Scripts to download or generate data
β β βββ great_expectations <- Folder containing data integrity check files
β β βββ make_dataset.py
β β βββ data_validation.py <- Script to run data integrity checks
β β
β βββ 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
β
βββ .pre-commit-config.yaml <- pre-commit hooks file with selected hooks for the projects.
βββ dvc.lock <- constructs the ML pipeline with defined stages.
βββ dvc.yaml <- Traing a model on the processed data.
Project based on the cookiecutter data science project template. #cookiecutterdatascience
To create a project like this, just go to https://dagshub.com/repo/create and select the Cookiecutter DVC project template.
Made with πΆ by DAGsHub.