From a68d7e41f80942b86a1991a5caaaa0aa99f7b67a Mon Sep 17 00:00:00 2001 From: Robert Stojnic Date: Wed, 1 Apr 2020 18:20:14 +0100 Subject: [PATCH] Minor wording tweaks and move README template to the top. --- README.md | 16 ++++++++++------ 1 file changed, 10 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index d76dcdf..073b0ec 100644 --- a/README.md +++ b/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