作者：Zolzaya Luvsandorj
翻譯：陳之炎
校對：趙茹萱

本文約2400字，建議閱讀5分鐘
本文為你介紹助力工作流文檔化的幾個實用技巧。

標簽：工作流文檔化

Jupyter筆記本（此文中所指的筆記本）的動人特點是能夠在代碼單元格旁邊使用標記單元格。這些標記單元格讓我們能夠更清晰地記錄文檔，方便用戶更容易理解筆記本的工作流。在這篇文章中，我將分享一些使用技巧，在無需安裝任何擴展文檔的情況下使得標記單元格更加豐富多彩。

圖片來源：Elena Kloppenburg ?

0. 復習（Refresher）

如果你一直在使用Jupyter筆記本，你可能已經(jīng)對標記的基本知識有所了解。這里用一分鐘時間來介紹一下標記使用的常用語法：

其輸出為：

在復習了基本內(nèi)容之后，接下來探尋一下更加復雜的標記單元格功能，以豐富文檔內(nèi)容，以提高可讀性。

1.代碼文本著色

大段的黑白文本閱讀起來非常晦澀。為使黑白文本更加豐富多彩，提高文本可讀性，可以為其添加色彩，突出顯示和彈出關(guān)鍵部分。這里有三種不同的方式來為文本添加顏色：

1.1. 文本著色

使用html字體標簽更改文本的顏色，可以使用顏色名稱或十六進制的顏色代碼：

例如：綠色文本，藍色斜體文本和紅色加粗文本

如果想探索更多的顏色名稱，這可能會派上用場。如果顏色名稱不能完全符合你的心意，可以用十六進制的顏色來獲得更廣泛的選擇。這是我最喜歡用的一些十六進制顏色的資源。

1.2. ?突出顯示文本（高亮）

使用html?標記突出顯示文本：

此外：可以高亮顯示文本

高亮部分的文本更容易引起人們的注意。

1.3.使用告警

最后，可以使用引導告警（ bootstrap alert）來格式化背景和字體顏色，使文本文檔閱讀起來更吸引人：

這些格式真漂亮！為文本添加顏色之后可以立即提高Notebook文檔的可讀性，使關(guān)鍵之處更加突出，閱讀文檔起來更加生動。這樣，快速瀏覽和快速獲取要點就變得更容易一些。

2. 適當格式化文本

另一種豐富文檔的方法是使用相應的富文格式，下面來看看三種不同的文本格式化方法：

2.1 用LaTeX插入數(shù)學方程式

當需要在筆記本文檔中引用數(shù)學方程時，可以使用$，利用LaTeX來顯示數(shù)學公式：

當方程在雙$之中時，它將在中心對齊。如果使用單個$，它將保持左對齊。或者，也可以使用這個語法來編寫公式：

2.2. ?使用代碼塊

有時，可以在標記單元格中顯示代碼引用，而非在代碼單元格中運行它們。可以使用單個反向引號`來顯示一個代碼塊：

對于大段的代碼塊，可以使用三重反向引號：

如果在第一個三重引號?`之后指定了語言名稱，那么將對代碼塊進行適當?shù)牟噬袷交?/span>

2.3. 使用引用縮進

縮進法是格式化文本以提高可讀性的另一種方法，可以用>添加縮進：

3. ?添加媒體

“一幅圖勝過千言萬語。”

文檔并不一定要用文字表示，圖片和其他媒體可以幫助我們交流那些原本很難用文本來表達的想法。添加相關(guān)媒體是使文檔更加豐富多彩的另一種好方法。

3.1. 插入GIF圖像

可以使用html標記來向標記單元格中添加圖像：

Pipeline, ColumnTransformer and FeatureUnion explained

這里，example.jpeg保存在與Notebook同一個文件夾中。可以使用寬度或高度參數(shù),對圖像的大小進行修改。例如，利用?將顯示的圖像大小調(diào)整為所需寬度，同時保持寬度與高度比。

如果在靜態(tài)圖像中添加圖表或表格等可視化數(shù)據(jù)還不足以完全捕捉到想要傳達的內(nèi)容，那么使用完全相同的語法結(jié)構(gòu)，可以嵌入GIF（動圖）：

數(shù)據(jù)科學的Git導論

文件的路徑也可以是一個web鏈接：

3.2.插入視頻

“一段（一分鐘）的視頻價值180萬字。”

如果GIF還不足夠，下一步便是使用視頻，可以使用html

例如，對如何完成任務進行錄屏之后，將其保存為視頻文件，并將該視頻插入到Notebook中，方便用戶日后使用。

3.3. ?添加形狀和表情符號

大段冗長的純文本讀起來可能相當無聊，也不值得閱讀，優(yōu)雅地添加形狀和表情符號可以使得文本更有趣，閱讀起來更引人入勝：

這里有更多的形狀（和表情符號），這個表情符號小單在搜索表情符號時很有用。

這些便是豐富Jupyter筆記本文檔的技巧。大家可能不會同時使用所有上述功能，但是知道如何使用可以讓你有備無患。

?圖片來源：Chris Lawton

希望訪問更多像這樣的內(nèi)容？Medium會員可以無限訪問媒體上的任何文章。如果你使用我的推薦鏈接成為會員，你的部分會費將直接支持我。

謝謝閱讀我的文章。如果想了解更多關(guān)于標記的信息，請查看本指南。如果你感興趣，下面有我的一些帖子的鏈接：

有用的IPython魔法命令

（https://towardsdatascience.com/useful-ipython-magic-commands-245e6c024711）

面向數(shù)據(jù)科學的Python虛擬環(huán)境介紹

（https://towardsdatascience.com/introduction-to-python-virtual-environment-for-data-science-3c216929f1a7）

pandas 用戶的5個技巧

（https://towardsdatascience.com/5-tips-for-pandas-users-e73681d16d17）

在 pandas中編寫5個常見的SQL查詢

（https://towardsdatascience.com/writing-5-common-sql-queries-in-pandas-90b52f17ad76）

原文標題：

Enrich your Jupyter Notebook with these tips

原文鏈接：

https://towardsdatascience.com/enrich-your-jupyter-notebook-with-these-tips-55c8ead25255?source=collection_home

編輯：于騰凱

校對：楊學俊

譯者簡介

陳之炎，北京交通大學通信與控制工程專業(yè)畢業(yè)，獲得工學碩士學位，歷任長城計算機軟件與系統(tǒng)公司工程師，大唐微電子公司工程師，現(xiàn)任北京吾譯超群科技有限公司技術(shù)支持。目前從事智能化翻譯教學系統(tǒng)的運營和維護，在人工智能深度學習和自然語言處理（NLP）方面積累有一定的經(jīng)驗。業(yè)余時間喜愛翻譯創(chuàng)作，翻譯作品主要有：IEC-ISO 7816、伊拉克石油工程項目、新財稅主義宣言等等，其中中譯英作品“新財稅主義宣言”在GLOBAL TIMES正式發(fā)表。能夠利用業(yè)余時間加入到THU 數(shù)據(jù)派平臺的翻譯志愿者小組，希望能和大家一起交流分享，共同進步

翻譯組招募信息

工作內(nèi)容：需要一顆細致的心，將選取好的外文文章翻譯成流暢的中文。如果你是數(shù)據(jù)科學/統(tǒng)計學/計算機類的留學生，或在海外從事相關(guān)工作，或?qū)ψ约和庹Z水平有信心的朋友歡迎加入翻譯小組。

你能得到：定期的翻譯培訓提高志愿者的翻譯水平，提高對于數(shù)據(jù)科學前沿的認知，海外的朋友可以和國內(nèi)技術(shù)應用發(fā)展保持聯(lián)系，THU數(shù)據(jù)派產(chǎn)學研的背景為志愿者帶來好的發(fā)展機遇。

其他福利：來自于名企的數(shù)據(jù)科學工作者，北大清華以及海外等名校學生他們都將成為你在翻譯小組的伙伴。

點擊文末“閱讀原文”加入數(shù)據(jù)派團隊~

轉(zhuǎn)載須知

如需轉(zhuǎn)載，請在開篇顯著位置注明作者和出處（轉(zhuǎn)自：數(shù)據(jù)派ID：DatapiTHU），并在文章結(jié)尾放置數(shù)據(jù)派醒目二維碼。有原創(chuàng)標識文章，請發(fā)送【文章名稱-待授權(quán)公眾號名稱及ID】至聯(lián)系郵箱，申請白名單授權(quán)并按要求編輯。

發(fā)布后請將鏈接反饋至聯(lián)系郵箱（見下方）。未經(jīng)許可的轉(zhuǎn)載以及改編者，我們將依法追究其法律責任。

點擊“閱讀原文”擁抱組織

獨家 | 幾個Jupyter筆記本的使用技巧