Skip to content

πŸ§‘β€πŸ’»: Algorithm README TemplateΒ #159

@that-ar-guy

Description

@that-ar-guy

πŸ”΄ 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.md file 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 :


Happy Contributing πŸš€

All the best. Enjoy your open source journey ahead. 😎

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions