From 686c22a88f0cd573a0336fde4b42dbce40eb7a1d Mon Sep 17 00:00:00 2001 From: UTSAV SINGHAL Date: Wed, 2 Oct 2024 16:32:38 +0530 Subject: [PATCH] Update .github --- .github/readme_template.md | 42 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 42 insertions(+) create mode 100644 .github/readme_template.md diff --git a/.github/readme_template.md b/.github/readme_template.md new file mode 100644 index 0000000000..c8853088c2 --- /dev/null +++ b/.github/readme_template.md @@ -0,0 +1,42 @@ +## **PROJECT TITLE** + +### ๐ŸŽฏ **Goal** + +`Write the main goal of project and what's the purpose of it.` + +### ๐Ÿงต **Dataset** + +`Add a link to dataset and from where it's taken.` + +### ๐Ÿงพ **Description** + +`Brief description about the project.` + +### ๐Ÿงฎ **What I had done!** + +`Write down the step by step procedure of how project works using points.` + +### ๐Ÿš€ **Models Implemented** + +`List out all the algorithms or models used in this project. Why have you choosed that algorithms should also be stated` + +### ๐Ÿ“š **Libraries Needed** + +`Add all the libraries needed in this project in points.` + +### ๐Ÿ“Š **Exploratory Data Analysis Results** + +`INCLUSION OF IMAGES OF THE VISUALIZATION IS MUST (RESULT OF EDA).` + +### ๐Ÿ“ˆ **Performance of the Models based on the Accuracy Scores** + +`Add all the algorithms used with their accuracies and results` + + +### ๐Ÿ“ข **Conclusion** + +`What's the conclusion derived from this project and also showcase the accuracy results if it's applicable. Be briefer. Use accuracy scores to find the best fitted model among all the developed models for the particular projects.` + +### โœ’๏ธ **Your Signature** + +`Add your name at the end of the file, along with social media handles if applicable!` \ No newline at end of file