选自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
有了这些项目,枯燥无味的文书作业都可以变得更有功率,还不会犯错。
本文为机器之心收拾,转载请联络本大众号取得授权。
------------------------------------------------
参加机器之心(全职记者 / 实习生):hr@jiqizhixin.com
投稿或寻求报导:content@jiqizhixin.com
广告 & 商务协作:bd@jiqizhixin.com