Minor wording tweaks and move README template to the top.
This commit is contained in:
16
README.md
16
README.md
@@ -1,12 +1,20 @@
|
||||
# Resources for releasing research code in Machine Learning
|
||||
|
||||
This repository contains resources for those wanting to publish a high impact ML research repository.
|
||||
|
||||
## README.md template
|
||||
|
||||
We provide a [README.md template](templates/README.md) for releasing ML research repositories.
|
||||
|
||||
## ML Code Completeness Checklist
|
||||
|
||||
We introduce the ML Code Completeness Checklist to:
|
||||
Goals of the ML Code Completeness Checklist:
|
||||
- facilitate reproducibility
|
||||
- make it easier for others build upon research code
|
||||
|
||||
For background and reasoning behind the checklist items please refer to our [medium post](https://medium.com/paperswithcode/). We also provide the [data](notebooks/code_checklist-neurips2019.csv) and [notebook](notebooks/code_checklist-analysis.Rmd) to reproduce this analysis from the medium post.
|
||||
We find that repositories that follow all of the checklist items get many more github stars (on median 200 more, and on average 2500 more).
|
||||
|
||||
For more details behind the checklist items please refer to our [medium post](https://medium.com/paperswithcode/). We also provide the [data](notebooks/code_checklist-neurips2019.csv) and [notebook](notebooks/code_checklist-analysis.Rmd) to reproduce this analysis from the medium post.
|
||||
|
||||
The checklist is made to be as general as possible. It consists of 5 items:
|
||||
|
||||
@@ -54,10 +62,6 @@ Releasing models is also useful if it's quick to train, as it serves as a point
|
||||
|
||||
## Awesome resources for releasing research code
|
||||
|
||||
### README.md templates
|
||||
|
||||
1. [Our README.md template](templates/README.md)
|
||||
|
||||
### Hosting pretrained models files
|
||||
|
||||
1. [GitHub Releases](https://help.github.com/en/github/administering-a-repository/managing-releases-in-a-repository) - versioning, 2GB file limit, free bandwidth
|
||||
|
||||
Reference in New Issue
Block a user