分享 - Hugging Face 文档

Hugging Face Hub 是一个用于分享、发现和消费各种类型和大小模型的平台。我们强烈建议在 Hub 上分享您的模型，以推动开源机器学习向前发展，造福所有人！

本指南将向您展示如何从 Transformers 将模型分享到 Hub。

设置

要将模型分享到 Hub，您需要一个 Hugging Face 账户。创建一个用户访问令牌（默认存储在缓存中），然后从命令行或笔记本登录您的账户。

huggingface-CLI

notebook

仓库功能

每个模型仓库都提供版本控制、提交历史和差异可视化功能。

版本控制基于 Git 和 Git Large File Storage (LFS)，它支持修订版本，可以通过提交哈希、标签或分支来指定模型版本。

例如，使用 from_pretrained() 中的 revision 参数从提交哈希加载特定的模型版本。

model = AutoModel.from_pretrained(
    "julien-c/EsperBERTo-small", revision="4c77982"
)

模型仓库还支持门控，以控制谁可以访问模型。门控通常用于允许一组选定的用户在研究模型公开之前进行预览。

模型仓库还包含一个用于用户直接与 Hub 上的模型进行交互的推理小部件。

有关更多信息，请查看 Hub 模型文档。

上传模型

根据您的工作流程偏好，有几种方法可以将模型上传到 Hub。您可以使用 Trainer 推送模型，直接在模型上调用 push_to_hub()，或者使用 Hub 的 Web 界面。

Trainer

训练后，Trainer 可以直接将模型推送到 Hub。在 TrainingArguments 中设置 push_to_hub=True，然后将其传递给 Trainer。训练完成后，调用 push_to_hub() 上传模型。

push_to_hub() 会自动将有用的信息，如训练超参数和结果，添加到模型卡片中。

from transformers import TrainingArguments, Trainer

training_args = TrainingArguments(output_dir="my-awesome-model", push_to_hub=True)
trainer = Trainer(
    model=model,
    args=training_args,
    train_dataset=small_train_dataset,
    eval_dataset=small_eval_dataset,
    compute_metrics=compute_metrics,
)
trainer.push_to_hub()

PushToHubMixin

The PushToHubMixin 提供了将模型或分词器推送到 Hub 的功能。

直接在模型上调用 push_to_hub() 将其上传到 Hub。它会在您的命名空间下创建一个仓库，模型名称在 push_to_hub() 中指定。

model.push_to_hub("my-awesome-model")

分词器等其他对象也可以以同样的方式推送到 Hub。

tokenizer.push_to_hub("my-awesome-model")

您的 Hugging Face 个人资料现在应该会显示新创建的模型仓库。导航到文件选项卡以查看所有上传的文件。

有关将文件推送到 Hub 的更多信息，请参阅将文件上传到 Hub 指南。

Hub Web 界面

Hub Web 界面是一种无需编码即可上传模型的便捷方法。

通过选择 新建模型 来创建一个新仓库。

为您的模型添加一些信息

选择仓库的所有者。可以是您自己，也可以是您所属的任何组织。
为您的模型选择一个名称，该名称也将是仓库名称。
选择您的模型是公开的还是私有的。
设置许可证使用情况。

点击创建模型以创建模型仓库。
选择文件选项卡，然后点击添加文件按钮将文件拖放至您的仓库。添加提交消息，然后点击提交更改到 main 以提交文件。

模型卡

模型卡片可以告知用户模型的性能、局限性、潜在偏差和道德考量。强烈建议为您的仓库添加模型卡片！

模型卡片是您仓库中的一个 README.md 文件。通过以下方式添加此文件：

手动创建并上传 README.md 文件
在仓库中点击编辑模型卡片按钮

请查看 Llama 3.1 模型卡片，了解模型卡片应包含的内容示例。

有关模型卡片元数据（碳排放、许可证、论文链接等）的更多信息，请参阅模型卡片指南。

在 GitHub 上更新