latex中⽂论⽂模板_论⽂LaTeX、项⽬README:⽆脑套⽤格
式、开源模板最⾼10万赞
选⾃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 模板,包括本科综合论⽂训练、硕⼠论⽂、博⼠论⽂以及博⼠后出站报告。
有了这些项⽬,枯燥⽆味的⽂书⼯作都可以变得更有效率,还不会出错。