From 72a36c3c831ab4f4f849ac4e4db39c0017757d81 Mon Sep 17 00:00:00 2001 From: super Date: Fri, 9 Oct 2020 07:32:07 +0800 Subject: [PATCH] Update README-CHS.md --- .DS_Store | Bin 0 -> 6148 bytes README-CHS.md | 38 +++++++++++++++----------------------- 2 files changed, 15 insertions(+), 23 deletions(-) create mode 100644 .DS_Store diff --git a/.DS_Store b/.DS_Store new file mode 100644 index 0000000000000000000000000000000000000000..c7d51a90750c8d9f217162789317b9bd59738097 GIT binary patch literal 6148 zcmeH~v1-FW42FNT9s*rFcDyBPA#ZSmOw5=M_`(Ti+>f`z<@gz@)<8p?Fp8zI)6o1mgxLET Hyi|c-gQgO9 literal 0 HcmV?d00001 diff --git a/README-CHS.md b/README-CHS.md index 9f8b2d7..bc6f27a 100644 --- a/README-CHS.md +++ b/README-CHS.md @@ -2,31 +2,23 @@ -**💡 整理了最受欢迎的ML研究论文代码库中的最佳做法，现在这已是 NeurIPS 2020 会议 的官方指南！** - -为了促进项目的可重复性，基于对 200 多个机器学习项目代码库的分析 和 GitHub Stars 数目 ，我们总结了如下建议。 - -有关更多详细信息，请参见我们的我们的 [博客文章](https://medium.com/paperswithcode/ml-code-completeness-checklist-e9127b168501)。 - - - -对于 NeurIPS 2020 会议 的代码提交，建议（但不是强制性的）使用 [用前须知.md 模板](templates/README.md)，并根据 ML代码完整性清单（如下所述）核对所有项目。 +**💡 整理了最受欢迎的ML研究论文代码库中的最佳实践，现已成为 NeurIPS 2020 会议的官方指南！** +为了促进项目的可重复性，基于对 200 多个机器学习项目代码库的分析和 GitHub Stars 的数目 ，我们总结了如下建议。有关更多详细信息，请参见我们的我们的 [博客文章](https://medium.com/paperswithcode/ml-code-completeness-checklist-e9127b168501)。 +对于 NeurIPS 2020 会议的代码提交，建议（但不是强制性的）使用 [用前须知.md 模板](templates/README.md)，并根据 ML代码完整性清单（如下所述）核对项目。 ## 📋 用前须知.md 模板 我们提供了一个 [用前须知.md 模板](templates/README.md)，可用于发布 ML 研究项目代码库。 -模板中的各节是通过查看在社区中最受欢迎的代码库，然后查看与受欢迎程度相关联的共同组件而得出的。 - - +模版中的各小节是通过查看在社区中最受欢迎的代码库并分析各代码库中与欢迎程度相关联的公共组件得到的。 ## ✓ ML代码完整性检查清单 -我们通过查看最受欢迎的 ML 研究项目代码库的共同点来编制此清单。 此外，我们优先考虑了可重复性高的项目，使得其他项目更容易基于此研究代码库构建。 +我们通过查看最受欢迎的 ML 研究项目代码库的共同点来编制此清单。 此外，我们优先考虑了可重复性高的项目，使得其他项目更容易基于此构建研究代码库。 -ML代码完整性检查清单包含五个要素： +ML代码完整性检查清单包含以下五个要素： 1. **依赖说明** @@ -38,11 +30,11 @@ ML代码完整性检查清单包含五个要素： 5. **自述文件，包括结果表格以及运行/产生这些结果的精确命令代码** -我们验证了满足检查清单中更多要素的代码库，也倾向于拥有更多的 GitHub Stars。 通过分析官方 NeurIPS 2019 代码库已验证了这一点——更多详细信息请访问我们的 [博客文章](https://medium.com/paperswithcode/ml-code-completeness-checklist-e9127b168501)。 我们还提供 [数据](notebooks/code_checklist-neurips2019.csv) and [笔记](notebooks/code_checklist-analysis.pdf)，以从帖子中复现此分析。 +我们证实，拥有代码完整性检查清单中更多要素的代码库，也倾向于拥有更多的 GitHub Stars。 通过分析官方 NeurIPS 2019 代码库已验证了这一点——更多详细信息请访问我们的 [博客文章](https://medium.com/paperswithcode/ml-code-completeness-checklist-e9127b168501)。 我们还提供 [数据](notebooks/code_checklist-neurips2019.csv) 和 [笔记](notebooks/code_checklist-analysis.pdf)以重现本文的分析。 -进一步的，满足所有这五个要素的 NeurIPS 2019 代码库，具有最高数量的 GitHub Stars（中位数196星，平均2664星）。 +进一步的，满足所有完整性检查清单中这五个要素的 NeurIPS 2019 代码库，具有最高数量的 GitHub Stars（中位数196星，平均2664星）。 -我们会针对检查清单上的每个要素进行详细说明。 +接下来，我们会针对检查清单上的每个要素进行详细说明。 #### 1. 依赖说明 @@ -50,11 +42,11 @@ ML代码完整性检查清单包含五个要素： 优秀的做法是在 **`用前须知.md`** 中安排一个小节，说明如何安装这些依赖项。 假定用户需要掌握最少的背景知识，并且要清楚而全面了解项目——如果用户无法设置您的依赖项，那么他们很可能也会放弃其余的代码。 -如果您希望提供整个可复现模型的环境，则可能要考虑使用 Docker 并将您环境的 Docker映像 上载到 Dockerhub 。 +如果您希望提供整个可复现模型的环境，则可能要考虑使用 Docker 并将您环境的 Docker镜像上传到 Dockerhub 。 #### 2. 训练代码 -您的代码应当包含一个训练脚本，该脚本可用于获取本文所述的主要结果。 这意味着脚本中应该包括模型超参数以及在获取结果的过程中使用的所有技巧。 为了最大程度地发挥作用，在编写此代码时，最好考虑到可扩展性：如果您的用户希望在自己的数据集上使用相同的训练脚本，该怎么办？ +您的代码应当包含一个训练脚本，该脚本可用于获取论文所述的主要结果。 这意味着脚本中应该包括模型超参数以及在获取结果的过程中使用的所有技巧。 为了最大程度地发挥作用，在编写此代码时，最好考虑到可扩展性：如果您的用户希望在自己的数据集上使用相同的训练脚本，该怎么办？ 您可以提供打包好的文档化的命令行程序（例如 `train.py` ）作为用户的使用入口。 @@ -70,13 +62,13 @@ ML代码完整性检查清单包含五个要素： 另一个常见使用场景是对下游任务进行微调，在此情况下，发布预训练模型非常有用，以便其他人可以在其基础上构建模型以应用于自己的数据集。 -最后，一些用户可能想尝试一下您的模型，看看它是否适用于某些示例数据。 提供预训练模型可以使您的用户随心所欲地玩转您的工作，并有助于理解您相关研究论文的成就。 +最后，一些用户可能想尝试一下您的模型，看看它是否适用于某些示例数据。 提供预训练模型可以使您的用户随心所欲地玩转您的工作，并有助于理解您论文中的成就。 #### 5. 自述文件，包括结果表格以及运行/产生这些结果的精确命令代码 -在 **`用前须知.md`** 中添加结果表格，可让您的用户快速了解代码库中的内容（有关示例，请参见 [用前须知.md 模板](templates/README.md)）。 有关如何复现这些结果的说明（带有任何相关脚本的链接，预训练的模型等）可以为用户提供另一个使用入口，并直接促进复现性。 在某些情况下，一篇论文的主要结果是一个图表，但对于用户而言，如果不阅读该论文，可能会难以理解该结果。 +在 **`用前须知.md`** 中添加结果表格，可让您的用户快速理解对代码库的期望（有关示例，请参见 [用前须知.md 模板](templates/README.md)）。 有关如何复现这些结果的说明（带有任何相关脚本，预训练模型等的链接）可以为用户提供另一个使用入口，并直接促进复现性。 在某些情况下，一篇论文的主要结果是一个图表，但对于用户而言，如果不阅读该论文，可能会难以理解该结果。 -您可以进一步的链接到包含其他论文的最新结果的完整指标排行榜，从而进一步帮助用户理解您的结果并将其关联起来。 有[多个排行榜服务](#指标排行榜)可以存储该信息。 +您可以进一步提供包含其他论文的最新结果的完整指标排行榜的链接，从而进一步帮助用户理解您的结果并将其关联起来。 有[多个排行榜服务](#指标排行榜)可以存储该信息。 @@ -132,4 +124,4 @@ ML代码完整性检查清单包含五个要素： 如果您想做出贡献或对这些指南有任何建议，可以通过 im.young@foxmail.com 与本中文界面维护者取得联系（或者通过 hello@paperswithcode.com 与 Paper with Code 联系 ），亦可在此 GitHub 项目中提出问题（open an issue）。 -任何贡献都是受到欢迎的！ 此项目中的所有内容均遵照 MIT许可 进行许可授权。 \ No newline at end of file +任何贡献都是受到欢迎的！ 此项目中的所有内容均遵照 MIT许可协议进行许可授权。 \ No newline at end of file