-
Notifications
You must be signed in to change notification settings - Fork 55
Closed
Labels
INTERMEDIATESWOCenhancementNew feature or requestNew feature or requesthelp wanted π°Extra attention is neededExtra attention is needed
Description
π΄ Title : adding a Algorithm README Template
π΄ Enhancement Aim : : To create a standardized, concise, and flexible README template for AI, ML, and DL algorithms.
π΄ Changes :
- Add a
ALGORITHM-README-TEMPLATE.mdfile in the root directory with sections like AIM, WORKING PRINCIPLE, APPLICATIONS, ADVANTAGES AND LIMITATIONS, CODE IMPLEMENTATION, EXAMPLES AND VISUALIZATIONS, PERFORMANCE METRICS, TRADE-OFFS, REFERENCES,. - This template will be specifically tailored for documenting algorithms, as project README template generally focus on the project overview
Screenshots π·
β To be Mentioned while taking the issue :
- Full name : MOHAMMED ABDUL RAHMAN
- What is your participant role? SWOC 5
Happy Contributing π
All the best. Enjoy your open source journey ahead. π
Metadata
Metadata
Assignees
Labels
INTERMEDIATESWOCenhancementNew feature or requestNew feature or requesthelp wanted π°Extra attention is neededExtra attention is needed