Hugging Face 的 Logo

Hub 文档

仓库入门

Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始

仓库入门

这份对初学者友好的指南将帮助你掌握在 Hub 上创建和管理仓库所需的基本技能。每个部分都建立在前一部分的基础上，所以请随意选择从哪里开始！

要求

本文档展示了如何通过 Web 界面以及终端处理仓库。如果使用 UI，则没有要求。如果你想使用终端，请按照这些安装说明进行操作。

如果你的 CLI 命令中没有 git，则需要为你的平台安装 Git。你还需要安装 Git LFS，它将用于处理大型文件，例如图像和模型权重。

为了能够将你的代码推送到 Hub，你需要以某种方式进行身份验证。最简单的方法是安装 huggingface_hub CLI 并运行登录命令

python -m pip install huggingface_hub
huggingface-cli login

本文档“入门”部分的内容也以视频形式提供！

创建仓库

使用 Hub 的 Web 界面，你可以轻松创建仓库、添加文件（甚至大型文件！）、探索模型、可视化差异等等。 Hub 上有三种类型的仓库，在本指南中，你将创建一个模型仓库用于演示目的。有关创建和管理模型、数据集和 Spaces 的信息，请参阅它们各自的文档。

  1. 要创建新仓库，请访问 huggingface.co/new

  1. 指定仓库的所有者：可以是您或您所属的任何组织。

  2. 输入您的模型名称。这也将是仓库的名称。

  3. 指定您希望您的模型是公开的还是私有的。

  4. 指定许可证。你现在可以留空“许可证”字段。要了解有关许可证的信息，请访问许可证文档。

创建模型仓库后，你应该会看到如下页面

请注意，Hub 会提示你创建一个模型卡片，你可以在模型卡片文档中了解相关信息。在你的模型仓库中包含模型卡片是最佳实践，但由于我们目前只是创建一个测试仓库，因此可以跳过此步骤。

向仓库添加文件 (Web UI)

要通过 Web UI 向仓库添加文件，请首先选择“文件”选项卡，导航到所需目录，然后单击“添加文件”。你将可以选择创建新文件或直接从计算机上传文件。

创建新文件

选择创建新文件将带你到以下编辑器屏幕，你可以在其中选择文件的名称、添加内容，并使用总结更改的消息保存文件。你可以选择“作为拉取请求打开”来创建一个拉取请求，而不是直接将新文件提交到仓库的 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，你还需要运行

huggingface-cli 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 上

←仓库 仓库设置→