跳转到主要内容

客户端库,用于在huggingface.co hub上下载和发布模型、数据集和其他仓库

项目描述


huggingface_hub library logo

这是 Huggingface Hub 的官方 Python 客户端。

Documentation GitHub release PyPi version PyPI - Downloads Code coverage

英文 | 德语 | 印地语 | 韩语 | 中文(简体)


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

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


欢迎使用 huggingface_hub 库

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

主要特性

安装

使用 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",
)

有关详细说明,请参阅 上传指南

集成到 Hub。

我们正在与一些有趣的开源机器学习库合作,以提供免费模型托管和版本控制。您可以在 此处 找到现有的集成。

优点包括

  • 为库及其用户免费托管模型或数据集。
  • 由于基于 Git 的方法,即使是大型文件也能实现内置的文件版本控制。
  • 为所有公开模型提供无服务器推理 API。
  • 浏览器小部件用于在浏览器中与上传的模型互动。
  • 任何人都可以为您的库上传新的模型,他们只需为模型添加相应的标签即可使其可发现。
  • 快速下载!我们使用 Cloudfront(一个 CDN)来地理复制下载,因此从全球任何地方都很快速。
  • 使用统计信息和更多功能即将推出。

如果您想集成您的库,请随意提交一个问题以开始讨论。我们编写了一份分步指南,用❤️展示如何进行此集成。

贡献(功能请求、错误等)非常欢迎 💙💚💛💜🧡❤️

每个人都欢迎贡献,我们重视每个人的贡献。代码并非唯一的帮助社区的方式。回答问题、帮助他人、联系并改进文档对社区来说极其有价值。我们编写了一份贡献指南,总结如何开始为这个仓库做贡献。

项目详情


发行历史 发布通知 | RSS 源

下载文件

下载适用于您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。

源代码发行版

huggingface_hub-0.25.1.tar.gz (365.7 kB 查看哈希值)

上传时间: 源代码

构建发行版

huggingface_hub-0.25.1-py3-none-any.whl (436.4 kB 查看哈希值)

上传时间: Python 3

由以下机构支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误记录 StatusPage StatusPage 状态页面