recodehive / machine-learning-repos

A curated list of awesome machine learning frameworks, libraries and software (by language). I
https://machine-learning-repos.vercel.app/
MIT License
149 stars 273 forks source link

📝[Docs]: Improve Code Documentation with Comments. #1236

Open shravya312 opened 2 weeks ago

shravya312 commented 2 weeks ago

Is there an existing issue for this?

Issue Description

I want to increase the understanding of the project.

Suggested Change

The purpose of functions, classes, and modules. The flow of data and control through the code. Key algorithms, methodologies, and their parameters used in the machine learning processes.

Rationale

I want to make project beginner and readers friendly by adding clear and concise comments for improving the understanding of the project.

Urgency

High

Record

github-actions[bot] commented 2 weeks ago

Thank you for creating this issue! 🎉 We'll look into it as soon as possible. In the meantime, please make sure to provide all the necessary details and context. If you have any questions reach out to LinkedIn. Your contributions are highly appreciated! 😊

Note: I Maintain the repo issue twice a day, or ideally 1 day, If your issue goes stale for more than one day you can tag and comment on this same issue.

You can also check our CONTRIBUTING.md for guidelines on contributing to this project.
We are here to help you on this journey of opensource, any help feel free to tag me or book an appointment.

sanjay-kv commented 2 weeks ago

at the moment readme looks fine, do you have an sample to show me

shravya312 commented 2 weeks ago

I want to add comments to code of machine learning project codes to improve the understanding of the code for the visitor,readers etc @sanjay-kv

sanjay-kv commented 2 weeks ago

you have to specify which code. we have 500+ project inside this repo

shravya312 commented 2 weeks ago

I want to add comments to Fetal Health Classification code under classification models @sanjay-kv