選自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
有了這些項目，枯燥無味的文書工作都可以變得更有效率，還不會出錯。
閱讀更多 機器之心Pro 的文章
