开云APP·官方入口(kaiyun)(中国)官方网站IOS/Android/手机app下载

选自GitHub机械之心整理到场：Jamin、思、一鸣纵然是最具创意性的机械学习研究者，也不得不面临枯燥无味的论文和项目文档写作。这项事情还怠慢不得，因为一旦少了重要的部门，很有可能对研究造成影响。在这里，机械之心整理了一些高赞开源项目 Readme、Gitignore 文档和论文的 LateX 模板。

纵然是初次研究的人也可以迅速上手。从搞研究到做项目，模板都是提高生产力的好工具。

因为开发者比力注重效率（因为懒），许多细枝末节而又略微繁琐的事情，都市在 GitHub 上放出模板。好比说 Git 用的 gitignore 文件，模板放到 GitHub 上竟然能有 9.6 万的 Star 量，这些小而好用的模板项目，确实能省不少事。gitignore 模板做项目岂论是做研究，还是平常写一些小项目，Git 总是必不行少的。

若不用 Git 追踪所有代码修改痕迹，总感受改代码、测试代码会比力心虚。一般使用 Git，又少不了 将代码托管到 GitHub，尤其现在 GitHub 已经支持免费的私有项目。然而做项目时，每次检察修改了哪些文件时，总会有一些奇奇怪怪的暂时文件，编译器缓存、系统缓存等等，此外数据集太大一般也不会传到 GitHub。

为了看着舒服，或许率你会写一个 . gitignore 文件，将需要 Git 忽略的所有文件、所有类型的文件都忽略掉。好比说，早几天清华大学开源的深度学习框架「计图」，它的 .gitignore 文件是这样的：可以想到，清华的研究者肯定是在构建项目的历程中，一条条把不希望添加到 GitHub 的文件清除在外。虽然要清除的文件每个项目都纷歧样，可是有一些肯定都是共通的，例如 __pycache__ 等。

这里我们先容一个 GitHub 官方 gitignore 模板，它现在拥有高达 9W+的 Star 量。这一系列模板很是好用，如果我们用 Python 做项目，直接下载对应的.gitignore 文件就行了。这个文件内部或许是这样的：它会从差别的角度展示 Python 项目到底哪些文件是应该清除在外，不能上传到代码库。

总文件有 143 行，我们直接下载用就行，只要再加上几行形貌自己项目的语句，.gitignore 就完美了。项目做完了，README 也不行少，是的，它也有模板。README 模板而 README 方面更是屡见不鲜，首先肯定的是 Readme 的本质，让读者能够以最快速度去相识如何安装或是使用项目。以前为了写一份 README 还要先去找一个成熟项目作为参照，好比耳熟能详的 由 RichardLitt 提倡的「Standard Readme」，简朴直白的告诉应该写哪些内容，应该如何排版等。

但此次向读者们先容的是专门针对于 Machine Learning 论文且附代码的 README 书写尺度及模板，让你不必在 README 的结构，排版上花更多时间。话不多说，来看参考图：第一部门肯定是论文的标题，以及包罗了可选择一些图表来简朴说明所使用的方法、主要结构或者是 bibtex 类型等。接着要简要说明安装要求，好比如何设置情况，如何使用 pip / conda / docker 下令，如何下载数据集等。

而接下来要针对训练来先容。形貌如何训练模型，并在论文中用示例下令去说明该如何训练模型，包罗完整的训练历程以及适当的超参数等。「Evaluation」此一项要先容如何凭据论文中的基准去评估训练后的模型。

而之后针对预训练模型，要提供有效链接，如何下载预训练模型，以及简要先容他们是如何被训练的。而最后，则是输出效果，效果对比以及排行榜等。

其实，从逻辑上看并不难，README 大部门操作是较为贫苦且花时间的，如果有了此模板，许多牢固的花样就可以直接套用，省去了不少时间。LaTeX 模板写论文如果实验做完了，README 也写好了，发现了惊人的效果，现在该投论文了。差别的大会都有一些花样上的要求，有时候他们也会在 GitHub 上公布 LaTex 论文模板。作为最后一步，本文推荐清华大学的结业论文模板，它包罗了完整的 LaTeX 文件，下载下来并修改内容后，一键就能生成尺度的 PDF。

该学位论文 LaTeX 模板，包罗本科综合论文训练、硕士论文、博士论文以及博士后出站陈诉。项目地址：https://github.com/xueruini/thuthesis有了这些项目，枯燥无味的文书事情都可以变得更有效率，还不会堕落。

本文来源：开云app官网入口-www.yufan-sz.com