Huggingface Hub 的官方 Python 客户端。
English | Deutsch | हिंदी | 한국어 | 中文(简体)
Documentation: https://hf.co/docs/huggingface_hub
Source Code: https://github.com/huggingface/huggingface_hub
欢迎来到 huggingface_hub 库
huggingface_hub
库让你可以与 Hugging Face Hub 互动,这是一个面向创作者和合作者的开放源代码机器学习平台。在这个平台上,你可以发现预训练模型和数据集用于你的项目,或者在 Hub 上使用成千上万的机器学习应用程序。你还可以创建和分享自己的模型、数据集和演示与社区交流。huggingface_hub
库提供了一个简单的方法来使用 Python 完成这些事情。
主要功能
安装
使用 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
# 或使用环境变量
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
我们与一些很酷的开源 ML 库合作,提供免费模型托管和版本管理。你可以在这里找到现有的集成。
其优势是:
- 为库及其用户提供免费的模型或数据集托管。
- 内置文件版本管理,即使是非常大的文件,通过基于 git 的方法。
- 所有公开可用模型的无服务器推理 API。
- 上传模型的浏览器小部件。
- 任何人都可以上传一个新的模型,只需要添加相应的标签,这样模型就可以被发现。
- 快速下载!我们使用 Cloudfront(一个 CDN)进行地理复制下载,因此从全球任何地方下载都非常快。
- 使用统计和更多功能即将推出。
如果你希望集成你的库,请随时开放一个问题开始讨论。我们写了一个逐步指南❤️,展示了如何进行这项集成。
欢迎各种贡献(功能请求、bug 等)💙💚💛💜🧡❤️
欢迎每个人的贡献,我们重视每个人的贡献。代码不是唯一帮助社区的方式。 回答问题、帮助他人、联系和改进文档对于社区来说是非常有价值的。 我们写了一个贡献指南 来总结如何开始为这个仓库做贡献。