[DOC] Create a detailed format for the project

gimseng / 99-ML-Learning-Projects

A list of 99 machine learning projects for anyone interested to learn from coding and building projects

MIT License

577 stars 174 forks source link

[DOC] Create a detailed format for the project #48

Open AjayKhalsa opened 3 years ago

AjayKhalsa commented 3 years ago

A template for readme page for each exercise and solution which would also contain links to quality resources on the topic in the solution readme. This would make learning more systematic and help people revise a topic before starting the project.

gimseng commented 3 years ago

@AjayKhalsa Thanks ! This is a good issue. We should discuss more details on a good format here. Any ideas / suggestions ?

AjayKhalsa commented 3 years ago

The format for the exercise readme could include explanation of the problem statement & explaining all the labels of the data & for the solution we could provide links for study material first to go through and then the solution with explanation (Preferably) as to why we followed that approach. The solution would be .ipynb file mostly and the resources would be in it's readme.

gimseng commented 3 years ago

@AjayKhalsa Great ! Like the idea. If others have suggestions/comments, do comments here.

Otherwise, there are at least two things to do:

[ ] Update readme for exercise and solution in 001 to provide an exemplary example of what we want.
[ ] Either in the contributing.md or in a new submitexercise.md (linked from main repo readme and contributing.md),details this format and provide examples of (for e.g.) how details or what format to adhere to. At various points, it would be helpful to link to the 001 example as a good format.

gimseng commented 3 years ago

@cundo92 This might be related to documentation and/or wiki, thought you might be interested.

cundo92 commented 3 years ago

Yea can definitely work on this

avats-dev commented 3 years ago

@gimseng I think creating a dummy exercise would do the job and as 000 exists, we can improve it so that people contributing would just have to copy the template and edit it for their use.

avats-dev commented 3 years ago

@gimseng I think creating a dummy exercise would do the job and as 000 exists, we can improve it so that people contributing would just have to copy the template and edit it for their use.

And we should also consider that, there are many possible solutions for a particular exercise, and so there might be different contributors for same exercise. So, this should also be taken into account while creating the format so that all contributors have options to add things and edit readme.

gimseng commented 3 years ago

@avats-dev Great ideas and I totally agree with both of your comments. Would you want to "upgrade" the 000 exercise? Thanks !

avats-dev commented 3 years ago

@gimseng , thanks for the opportunity, I will start working on it.