Machine Learning Articles
About
A repository for organizing different topics of machine learning articles in the form of Github's Issues. This idea is inspired by this arXivTimes repository on summarizing machine learning papers. The article of this repo can be found here
The website of this repo could be found here and the list of articles can be found in the Issues section of the main repo here.
Motivation
Have you ever read an interesting article and want to keep it somewhere for future reference or share it with your friends? If you are successfully keeping it in a folder, it will be easily forgetten and hard to find that particular article in your pile of articles.
Solution
Use this repository as a way to keep track of your favorite articles as well as see what other interesting articles that people are reading.
Why should you Contribute?
Keeping track of articles in this repository comes with multiple benefits:
- Organized your articles so that it is easy find your article for future reference
- Quickly review the key points of the articles without reading the whole articles
- The art of summarizing will help you to retain and comprehend the information better
- Save the time of going through low-quality article by looking at the articles others enjoy
- Ask questions or express your opinons on the articles in the comment section of Issues
How to Contribute
Format
To contribute a paper, please follow the format listed below:
- For articles that you would like to contribute, please create a new "Issue". A template will be created as you create a new issue. All you need is to fill in the section
- Use the name of the article as the title of the Issues.
- Use the following guidelines when submitting a new entry (Feel free to skip any section that is not relevant to what you are looking for):
- TL;DR - A quick short sentence summary of the paper.
- Link to the article.
- Author
- Key Takeaways - parts of the articles that you find useful.
- Useful Code Snippets - useful codes that you want to save for later
- Useful Tools - useful tools that you want to try out or integrate into your workflow
- Comments/Questions - Your thoughts or questions on the articles.
- What do you like about this article? What you wish to learn more from?
- What issues you have while trying to follow the codes or setup in the article?
- What parts of the articles that you are puzzling about?
The general template to be used can be found here. Sample example of an issue can be found here
Tips
- The length of the TL;DR should be enough to fit in a single tweet (~140 characters). The "ideal" TL;DR should capture the essence of the problem being solved, the solution/approach the author has taken and the results. Please try your best to help communicate the essence of the article!
- Remember, regard this as your own folder. Just write down the things that you think will be useful for yourself to look back! If an article has many pieces of information, some of which you already know and too lazy to write down in the template. Just write down whatever you feel like writing. It is better to write something than give it up all the way
- If you are making a contribution for a specific article, please designate yourself within the Assignees of the issue. This will help us to identify who has provided content and accordingly give credit.
- Use the Labels to tag the category of the article accordingly. (Currently only contributors are only allowed to issue those tags, thus we'll take care of the tagging when submissions have been recieved.)
- Use the comments section as a place to discuss, comment, ask questions or give feedback on the article.
Ideas for those who make fork, create Issues from origin
-
Fork repository
-
Enable Issues in Settings -> Issues
The steps 1 and 2 need be manual
-
We need set Personal Access Token (PAT):
- Your Profile -> Settings
- Developers -> Personal access token
- Add new Token (copy for use in Secrets) Make sure set the scopes: repo Ex: Machine Learning Articles Access — repo
3.1 Settings your Repo:
- Settings -> Secrets
- Add a new secret:
ACTIONS_SECRET :
<paste personal access token generated before>
-
Create final release: v1.0.0 (Import Issues to the repository)
- Optional you can create one Project(machine-learning-articles/projects) named Machine Learning Articles (To do , In progress, Done) for manage the Issues
How to
Add image
Adding image can be helpful to know what the article about. Simply copy the address of the image in the website and use  to add image to your issue!
For proposing any meta-level changes to this repository, such as adding more tags, changing the template format, please create a new issue using the proposal tag and provide us with your feedback!