huggingface_hub

Huggingface Hub 的官方 Python 客户端。

英语|德语 | हिंदी | 한국어 | 中文（简体）

---

文档：https://hf.co/docs/huggingface_hub

源代码：https://github.com/huggingface/huggingface_hub

---

欢迎来到 Huggingface_hub 库

huggingface_hub库允许您与 Hugging Face Hub 进行交互，这是一个为创作者和合作者实现开源机器学习民主化的平台。发现适合您的项目的预训练模型和数据集，或使用 Hub 上托管的数千个机器学习应用程序。您还可以创建并与社区共享您自己的模型、数据集和演示。 huggingface_hub库提供了一种使用 Python 完成所有这些操作的简单方法。

主要特点

• 从集线器下载文件。
• 将文件上传到集线器。
• 管理您的存储库。
• 在部署的模型上运行推理。
• 搜索模型、数据集和空间。
• 共享模型卡来记录您的模型。
• 通过 PR 和评论与社区互动。

安装

使用 pip 安装huggingface_hub包：

pip install huggingface_hub

如果您愿意，也可以使用 conda 安装它。

为了在默认情况下保持包最小化， huggingface_hub附带了对某些用例有用的可选依赖项。例如，如果您想获得完整的推理体验，请运行：

pip install huggingface_hub[inference]

要了解更多安装和可选依赖项，请查看安装指南。

快速启动

下载文件

下载单个文件

 from huggingface_hub import hf_hub_download

hf_hub_download ( repo_id = "tiiuae/falcon-7b-instruct" , filename = "config.json" )

或者整个存储库

 from huggingface_hub import snapshot_download

snapshot_download ( "stabilityai/stable-diffusion-2-1" )

文件将下载到本地缓存文件夹中。本指南中有更多详细信息。

登录

Hugging Face Hub 使用令牌来验证应用程序（请参阅文档）。要登录您的计算机，请运行以下 CLI：

huggingface-cli login
# or using an environment variable
huggingface-cli login --token $HUGGINGFACE_TOKEN

创建存储库

 from huggingface_hub import create_repo

create_repo ( repo_id = "super-cool-model" )

上传文件

上传单个文件

 from huggingface_hub import upload_file

upload_file (
    path_or_fileobj = "/home/lysandre/dummy-test/README.md" ,
    path_in_repo = "README.md" ,
    repo_id = "lysandre/test-model" ,
)

或者整个文件夹

 from huggingface_hub import upload_folder

upload_folder (
    folder_path = "/path/to/local/space" ,
    repo_id = "username/my-cool-space" ,
    repo_type = "space" ,
)

详情请参阅上传指南。

集成到集线器。

我们正在与超酷的开源 ML 库合作，提供免费的模型托管和版本控制。您可以在此处找到现有的集成。

优点是：

• 为图书馆及其用户提供免费模型或数据集托管。
• 得益于基于 git 的方法，即使文件非常大，也可以进行内置文件版本控制。
• 适用于所有公开可用模型的无服务器推理 API。
• 用于处理上传模型的浏览器内小部件。
• 任何人都可以为您的库上传新模型，他们只需添加相应的标签即可发现该模型。
• 下载速度快！我们使用 Cloudfront（CDN）进行地理复制下载，以便它们可以从全球任何地方快速下载。
• 使用情况统计数据和更多功能即将推出。

如果您想集成您的库，请随时打开一个问题来开始讨论。我们编写了一份分步指南，其中 ❤️ 展示了如何进行此集成。

非常欢迎贡献（功能请求、错误等）？？？❤️

欢迎每个人做出贡献，我们重视每个人的贡献。代码并不是帮助社区的唯一方法。回答问题、帮助他人、接触和改进文档对于社区来说非常有价值。我们编写了一份贡献指南来总结如何开始为此存储库做出贡献。