From ac1ba0cf71ca65a8dacfe547f9a3860d452eb6e4 Mon Sep 17 00:00:00 2001 From: Robert Stojnic Date: Mon, 6 Apr 2020 16:39:24 +0100 Subject: [PATCH] Tune wording --- README.md | 10 ++++++++-- templates/README.md | 5 ++++- 2 files changed, 12 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6ad6103..08bd4fb 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,10 @@ # Resources for Code Release in Machine Learning -This repository contains resources for those wanting to publish a high impact ML research repository. +This repository contains official **NeurIPS 2020 code submission** resources. + +For NeurIPS 2020 code submissions we recommend using a [README.md template](#readmemd-template) and checking as many items on the [ML Code Completeness Checklist](#ml-code-completeness-checklist) as possible. + +The recommendation is based on a [data-driven analysis](https://medium.com/paperswithcode) of what makes a research code repository have high impact. ## README.md template @@ -24,6 +28,8 @@ The checklist is made to be as general as possible. It consists of five items: 4. Table/Figure of the main result, with instruction to reproduce it 5. Pre-trained model +We found that NeurIPS 2019 repositories that have all five of these components got the highest number of GitHub stars. + We'll explain each one in some detail below. #### 1. Specification of dependencies @@ -60,7 +66,7 @@ Another common use case is fine-tuning for downstream task, where it's useful to Lastly, some users might want to try out your model to see if it works on some example data. Providing pre-trained models allows your users to play around with your work and aids understanding of the paper's achievements. -## Awesome resources for releasing research code +## Other awesome resources for releasing research code ### Hosting pretrained models files diff --git a/templates/README.md b/templates/README.md index d2d86df..a926732 100644 --- a/templates/README.md +++ b/templates/README.md @@ -4,7 +4,7 @@ This repository is the official implementation of [My Paper Title](https://arxiv.org/abs/2030.12345). -> 📋Optional: include a graphic explaining your approach/main result and the bibtex entry +> 📋Optional: include a graphic explaining your approach/main result, bibtex entry, link to demos, blog posts and tutorials ## Requirements @@ -57,3 +57,6 @@ Our model achieves the following performance on : > 📋Include a table of results from your paper, and link back to the leaderboard for clarity and context. If your main result is a figure, include that figure and link to the command or notebook to reproduce it. +## Contributing + +> 📋Pick a licence and describe how to contribute to your code repository. \ No newline at end of file