Skip to content

Latest commit

 

History

History
117 lines (49 loc) · 2.48 KB

readme_template.md

File metadata and controls

117 lines (49 loc) · 2.48 KB

PROJECT TITLE

The project title should be "Name of the Algorithm" or "Name of the Tutorial you'll showcasing about

GOAL

Write the main goal of this project and what's the purpose of it

PURPOSE

What's the purpose of this "Title Taken"

DATASET (if applicable)

Add a link to dataset and from where it's taken.

DESCRIPTION

Short description about the idea and approach you had gone with

WHAT I HAD DONE

What have you worked on for this issue should be stated using points.

WORKFLOW OF YOUR PROJECT FILES

Add the workflow of the script point by point to get good understanding of the concept

DIAGRAMS

Showcase various diagrams or flowcharts to get good understanding of this concept in an explanatory manner. Visual reprsentations makes things more clear.

STATE YOUR PROCEDURE AND UNDERSTANDING FROM YOUR WORK

List out the procedure you had used and how did you implement it.

Why had you choose this approach and what is your understanding from your work you had done.

What did you learn while working on this issue.

Why have you choosed this methodology should also be stated.

DETAILED EXPLANATION OF SCRIPT, IF APPLICABLE

Provide detailed explanation of the script in elaborative manner using points

USAGE

Why have you choosed this issue specifically should be stated

USE CASES

Explain few examples where this can work in an explanatory way to provide good efficiency and optimum results

LIBRARIES USED

Add all the libraries you had used to explain this concept

ADVANTAGES

Advantages of this issue for one to choose this concept

DISADVANTAGES

Disadvantages of this concept and where this can't be implied should be stated here

APPLICATIONS

List out all the applications where this concept can be useful

RESEARCH

Have you done any research on this issue, if so describe more on it

SCREENSHOTS

Add screenshots of the output or visualizations or anything related to your script to show it works

CONCLUSION

What's the conclusion of this concept. It should be clear and precise. Also showcase the appropriate results derived if it's applicable. Be briefer.

REFERENCES

Add all the references you had referred to provide good understanding on this concept. Add all the references beginner should refer to clear their concepts.

YOUR NAME

Add your full name, also can add your social media links if any.

DISCLAIMER, IF ANY

Use this section to mention if any particular disclaimer is required