讀者的貢獻 幫助我們改進本書。如果您發現拼寫錯誤、過時的鏈接、您認為我們遺漏了引文、代碼看起來不優雅或解釋不清楚的地方,請回饋并幫助我們幫助我們的讀者。雖然在普通書籍中,印刷運行之間的延遲(以及錯別字更正之間的延遲)可以以年為單位來衡量,但通常需要數小時到數天才能將改進納入本書。由于版本控制和持續集成 (CI) 測試,這一切都是可能的。為此,您需要向 GitHub 存儲庫提交拉取請求。當您的拉取請求被作者合并到代碼存儲庫中時,您將成為貢獻者。
23.6.1。提交小改動
最常見的貢獻是編輯一個句子或修正拼寫錯誤。我們建議您在GitHub 存儲庫中找到源文件并直接編輯該文件。例如,您可以通過查找文件按鈕(圖 23.6.1)搜索文件以找到源文件(markdown 文件)。然后單擊右上角的“編輯此文件”按鈕以在降價文件中進行更改。
完成后,在頁面底部的“建議文件更改”面板中填寫您的更改說明,然后單擊“建議文件更改”按鈕。它會將您重定向到一個新頁面以查看您的更改(圖 23.6.7)。如果一切順利,您可以通過單擊“創建拉取請求”按鈕來提交拉取請求。
23.6.2。提出重大改變
如果你計劃更新大部分文本或代碼,那么你需要更多地了解本書使用的格式。源文件基于markdown 格式,通過d2lbook包提供了一組擴展 ,例如引用方程式、圖像、章節和引用。您可以使用任何降價編輯器打開這些文件并進行更改。
如果您想更改代碼,我們建議您使用 Jupyter Notebook 打開這些 markdown 文件,如第 23.1 節所述。這樣您就可以運行并測試您的更改。請記住在提交更改之前清除所有輸出,我們的 CI 系統將執行您更新的部分以生成輸出。
某些部分可能支持多個框架實現。如果你添加一個新的代碼塊,請%%tab
在開始行使用 來標記這個塊。例如,對于 PyTorch 代碼塊, 對于 TensorFlow 代碼塊,或者所有實現的共享代碼塊。您可以參考 < http://book.d2l.ai/user/code_tabs.html >`__ 包了解更多信息。%%tab pytorch
%%tab tensorflow
%%tab all
`d2lbook
23.6.3。提交重大變更
我們建議您使用標準 Git 流程來提交重大更改。簡而言之,該過程的工作原理如圖 23.6.2所示。
我們將引導您詳細完成這些步驟。如果您已經熟悉 Git,則可以跳過本節。為了具體起見,我們假設貢獻者的用戶名為“astonzhang”。
23.6.3.1。安裝 Git
Git 開源書籍描述了如何安裝 Git。這通常通過 在 Ubuntu Linux 上運行,通過在 macOS 上安裝 Xcode 開發人員工具,或使用 GitHub 的桌面客戶端。如果您沒有 GitHub 帳戶,則需要注冊一個。apt install git
23.6.3.2。登錄 GitHub
在瀏覽器中輸入本書代碼庫的地址。點擊圖23.6.3Fork
右上角紅框內的按鈕,復制本書的資源庫。現在這是您的副本,您可以隨意更改它。
現在,本書的代碼庫將被分叉(即復制)到您的用戶名,如圖23.6.4astonzhang/d2l-en
左上角所示 。
23.6.3.3。克隆存儲庫
要克隆存儲庫(即制作本地副本),我們需要獲取其存儲庫地址。圖 23.6.5中的綠色按鈕 顯示了這一點。如果您決定將此分叉保留更長時間,請確保您的本地副本與主存儲庫保持同步。現在只需按照安裝中的說明開始。主要區別在于您現在正在下載自己的存儲庫分支。
# Replace your_github_username with your GitHub username
git clone https://github.com/your_github_username/d2l-en.git
23.6.3.4。編輯和推送
現在是編輯這本書的時候了。最好按照第 23.1 節中的說明在 Jupyter Notebook 中編輯它。進行更改并檢查它們是否正常。假設我們修改了文件中的拼寫錯誤 ~/d2l-en/chapter_appendix-tools-for-deep-learning/contributing.md
。然后您可以檢查更改了哪些文件。
此時Git會提示文件 chapter_appendix-tools-for-deep-learning/contributing.md
已被修改。
mylaptop:d2l-en me$ git status
On branch master
Your branch is up-to-date with 'origin/master'.
Changes not staged for commit:
(use "git add ..." to update what will be committed)
(use "git checkout -- ..." to discard changes in working directory)
modified: chapter_appendix-tools-for-deep-learning/contributing.md
確認這是你想要的后,執行以下命令:
更改后的代碼將位于您個人的存儲庫分支中。要請求添加您的更改,您必須為本書的官方存儲庫創建拉取請求。
評論
查看更多