Repository 入門

這份面向初學者的指南將幫助你掌握在 Hub 上建立和管理 repository 所需的基本技能。每個部分都建立在前一個部分的基礎上，所以你可以隨意選擇從哪裡開始！

要求

本文件演示瞭如何透過 Web 介面和終端處理 repository。如果使用 UI，則沒有要求。如果您想使用終端，請按照這些安裝說明操作。

如果您的 CLI 命令中尚無 `git`，則需要為您的平臺安裝 Git。您還需要安裝 Git LFS，它將用於處理大型檔案，例如影像和模型權重。

為了能夠將您的程式碼推送到 Hub，您需要進行某種形式的身份驗證。最簡單的方法是安裝 `huggingface_hub` CLI 並執行登入命令

python -m pip install huggingface_hub
hf auth login

本文件“入門”部分的內容也以影片形式提供！

建立儲存庫

使用 Hub 的 Web 介面，您可以輕鬆建立 repository、新增檔案（甚至大型檔案！）、探索模型、視覺化差異等等。Hub 上有三種類型的 repository，本指南將建立一個**模型 repository** 用於演示。有關建立和管理模型、資料集和 Space 的資訊，請參閱其各自的文件。

要建立新儲存庫，請訪問 huggingface.co/new

指定倉庫所有者：可以是您本人，也可以是您所屬的任何組織。
輸入模型名稱。這將同時是倉庫的名稱。
指定您希望模型是公開的還是私有的。
指定許可證。您現在可以暫時將“許可證”欄位留空。要了解有關許可證的資訊，請訪問**許可證**文件。

建立模型倉庫後，您應該會看到類似以下頁面：

請注意，Hub 會提示您建立一份“模型卡”，您可以在**模型卡文件**中瞭解更多資訊。在模型倉庫中包含模型卡是最佳實踐，但由於我們目前只建立一個測試倉庫，因此可以跳過此步驟。

向倉庫新增檔案（Web UI）

要透過 Web UI 將檔案新增到您的 repository，請先選擇 **Files** 選項卡，導航到所需目錄，然後單擊 **Add file**。您將可以選擇建立新檔案或直接從計算機上傳檔案。

建立新檔案

選擇建立新檔案將帶您進入以下編輯器螢幕，您可以在其中為檔案選擇名稱，新增內容，並使用總結更改的訊息儲存檔案。您也可以選擇“Open as a pull request”來建立拉取請求，而不是直接將新檔案提交到您的倉庫的`main`分支。

上傳檔案

如果選擇*上傳檔案*，您將能夠選擇要上傳的本地檔案，並附帶一條訊息，總結您對倉庫所做的更改。

與建立新檔案一樣，您可以選擇“開啟拉取請求”以建立拉取請求，而不是直接將更改新增到您的倉庫的`main`分支。

向倉庫新增檔案（終端）

克隆倉庫

將倉庫下載到本地計算機稱為*克隆*。您可以使用以下命令載入倉庫並導航到它：

git clone https://huggingface.co/<your-username>/<your-model-name>
cd <your-model-name>

或者對於資料集倉庫：

git clone https://huggingface.co/datasets/<your-username>/<your-dataset-name>
cd <your-dataset-name>

您可以使用以下命令透過 SSH 克隆：

git clone git@hf.co:<your-username>/<your-model-name>
cd <your-model-name>

您需要將您的 SSH 公鑰新增到您的使用者設定中，才能推送更改或訪問私有倉庫。

設定

現在，您可以向倉庫新增任何您想要的檔案了！🔥

您有大於 10MB 的檔案嗎？這些檔案應該使用 `git-lfs` 進行跟蹤，您可以使用以下命令進行初始化：

git lfs install

請注意，如果您的檔案大於 **5GB**，您還需要執行：

hf lfs-enable-largefiles .

當您使用 Hugging Face 建立倉庫時，Hugging Face 會自動在 `.gitattributes` 檔案中提供常見機器學習大型檔案的常見副檔名列表，`git-lfs` 使用該檔案有效地跟蹤大型檔案的更改。但是，如果您的檔案型別尚未處理，您可能需要新增新的副檔名。您可以使用 `git lfs track "*.your_extension"` 來完成此操作。

推送檔案

您可以使用 Git 將新檔案和任何對現有檔案的更改儲存為一組稱為*提交*的更改，這可以被視為對專案的“修訂”。要建立提交，您必須 `add` 檔案以讓 Git 知道我們計劃儲存更改，然後 `commit` 這些更改。為了將新提交與 Hugging Face Hub 同步，您然後將提交 `push` 到 Hub。

# Create any files you like! Then...
git add .
git commit -m "First model version"  # You can choose any descriptive message
git push

大功告成！您可以在 Hugging Face 上檢視您的倉庫以及所有最近新增的檔案。例如，在下面的螢幕截圖中，使用者添加了許多檔案。請注意，此示例中的某些檔案大小為 `1.04 GB`，因此倉庫使用 Git LFS 來跟蹤它。

如果您使用 HTTP 克隆了倉庫，則每次推送操作時都可能會要求您填寫使用者名稱和密碼。避免重複的最簡單方法是切換到 SSH，而不是 HTTP。或者，如果您必須使用 HTTP，您可能會發現設定一個git 憑據助手來自動填充您的使用者名稱和密碼會有所幫助。

檢視倉庫歷史

每次您完成 `add`-`commit`-`push` 迴圈後，倉庫都會跟蹤您對檔案所做的每個更改。UI 允許您探索模型檔案和提交，並檢視每個提交引入的差異（也稱為*diff*）。要檢視歷史記錄，您可以單擊“**歷史記錄：X 次提交**”連結。

您可以點選單個提交以檢視該提交引入了哪些更改。

< > 在 GitHub 上更新