Hub Python Library documentation

搜索 Hub

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

搜索 Hub

在本教程中,您将学习如何使用 huggingface_hub 在 Hub 上搜索模型、数据集和空间。

如何列出仓库?

huggingface_hub 库包含一个 HTTP 客户端 HfApi,用于与 Hub 进行交互。 除此之外,它还可以列出存储在 Hub 上的模型、数据集和空间:

>>> from huggingface_hub import HfApi
>>> api = HfApi()
>>> models = api.list_models()

list_models() 的输出是一个迭代器,用于遍历 Hub 上存储的模型。

类似地,你可以使用 list_datasets() 列出数据集,使用 list_spaces() 列出 Spaces。

如何筛选仓库?

列出仓库固然不错,但你可能还想对搜索结果进行筛选。 列表辅助函数具有多个属性,例如:

  • filter
  • author
  • search
  • num_parameters
  • …

让我们看一个示例,获取 Hub 上所有执行图像分类、在 imagenet 数据集上训练且支持 PyTorch 的模型。

models = hf_api.list_models(filter=["image-classification", "pytorch", "imagenet"])

您还可以使用与 Hub 界面相同的范围语法,按参数量筛选模型:

models = hf_api.list_models(num_parameters="min:6B,max:128B")

在筛选时,你还可以对模型进行排序,仅获取排名靠前的结果。例如,以下示例获取了 Hub 上下载量最多的前 5 个数据集:

>>> list(list_datasets(sort="downloads", limit=5))
[DatasetInfo(
	id='argilla/databricks-dolly-15k-curated-en',
	author='argilla',
	sha='4dcd1dedbe148307a833c931b21ca456a1fc4281',
	last_modified=datetime.datetime(2023, 10, 2, 12, 32, 53, tzinfo=datetime.timezone.utc),
	private=False,
	downloads=8889377,
	(...)

要探索 Hub 上可用的筛选器,请在浏览器中访问 models 和 datasets 页面,搜索一些参数并查看 URL 中的值。

使用 CLI

您还可以使用 hf 命令行界面来列出和搜索模型、数据集和 Spaces:

# List models
>>> hf models ls --search "llama" --sort downloads --limit 5

# List datasets
>>> hf datasets ls --author Qwen

# List Spaces
>>> hf spaces ls --search "3d"

# Get info about a specific model
>>> hf models info Lightricks/LTX-2

有关更多详细信息,请参阅CLI 指南。

Update on GitHub