From cf95c4836a57fa08b5fa304553c0d0dcf4a168d4 Mon Sep 17 00:00:00 2001 From: Ronil Patil <63307564+ronylpatil@users.noreply.github.com> Date: Tue, 7 May 2024 12:15:29 +0530 Subject: [PATCH] update README.md --- README.md | 26 +++++++++++++++++++++++--- 1 file changed, 23 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 99d40f7..14e2491 100644 --- a/README.md +++ b/README.md @@ -3,15 +3,35 @@ MLflow Pipeline Built E2E ML Pipeline with MLflow & AWS. -
Project based on the cookiecutter data science project template. #cookiecutterdatascience
+ +## Installation + +1. Clone the repository. +2. Install dependencies using `pip install -r requirements.txt` + +## Folder Structure +- `/.github`: Contains CI/CD workflow file. +- `/.dvc`: Contains configuration files of DVC +- `/data`: Stores raw and processed data. +- `/log`: Store the logs. +- `/src`: Contains the source code files. +- `/prod`: Production files. +- `/tests`: Testing files. + +## Dataset + +- Download the dataset from [here](https://www.kaggle.com/datasets/yasserh/wine-quality-dataset). + +--- +Project based on the cookiecutter data science project template.