Hub documentation

在 Hugging Face 上使用 spaCy

Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

在 Hugging Face 上使用 spaCy

spaCy 是一个广受欢迎的用于高级自然语言处理的库,在业界被广泛使用。spaCy 让构建和训练用于命名实体识别、文本分类、词性标注等任务的流水线变得简单,并允许您构建强大的应用程序来处理和分析大量文本。

在 Hub 中探索 spaCy 模型

spaCy 3.3 的官方模型位于 spaCy 的 组织页面。社区中的任何人都可以分享他们的 spaCy 模型,您可以在 模型页面 左侧通过筛选找到这些模型。

Hub 上的所有模型都附带了实用功能

  1. 自动生成的模型卡片,包含标签方案、指标、组件等。
  2. 右上角有一个评估部分,您可以在其中查看各项指标。
  3. 有助于提高可发现性并包含许可证和语言等信息的元数据标签。
  4. 一个交互式小部件,可直接在浏览器中用于体验该模型
  5. 一个用于发起推理请求的 Inference Providers 小部件。

使用现有模型

Hub 上的所有 spaCy 模型都可以直接使用 pip install 安装。

pip install "en_core_web_sm @ https://huggingface.co/spacy/en_core_web_sm/resolve/main/en_core_web_sm-any-py3-none-any.whl"

要找到所需的链接,您可以前往包含 spaCy 模型的仓库。打开仓库后,点击 Use in spaCy,即可获得一个可用的代码片段,用于安装并加载该模型!

安装完成后,您可以像加载任何 spaCy 管道一样加载该模型。

# Using spacy.load().
import spacy
nlp = spacy.load("en_core_web_sm")

# Importing as module.
import en_core_web_sm
nlp = en_core_web_sm.load()

共享您的模型

使用 spaCy CLI(推荐)

spacy-huggingface-hub 库扩展了 spaCy 的原生 CLI,使用户可以轻松地将打包好的模型推送到 Hub。

您可以从 pip 安装 spacy-huggingface-hub:

pip install spacy-huggingface-hub

然后,您可以检查该命令是否已成功注册

python -m spacy huggingface-hub --help

要通过 CLI 推送,您可以使用如下所示的 huggingface-hub push 命令。

python -m spacy huggingface-hub push [whl_path] [--org] [--msg] [--local-repo] [--verbose]
参数类型描述
whl_pathstr / Path使用 spacy package 打包的 .whl 文件的路径。
--org, -ostr要上传该 pipeline 的组织的可选名称。
--msg, -mstr用于更新的提交信息。默认为 "Update spaCy pipeline"。
--local-repo, -lstr / Path模型仓库的本地路径(如果不存在则会自动创建)。默认值为当前工作目录下的 hub。
--verbose, -Vbool输出额外的调试信息,例如完整的生成 hub 元数据。

然后,您可以上传任何使用 spacy package 打包的 pipeline。请确保设置 --build wheel 以输出二进制 .whl 文件。上传器将从 pipeline 包中读取所有元数据,包括自动生成的美观 README.md 以及 meta.json 中可用的模型详细信息。

hf auth login
python -m spacy package ./en_ner_fashion ./output --build wheel
cd ./output/en_ner_fashion-0.0.0/dist
python -m spacy huggingface-hub push en_ner_fashion-0.0.0-py3-none-any.whl

只需一分钟,你就可以将打包好的模型上传到 Hub,直接在浏览器中试用,并与社区其他成员分享。所有必需的元数据都会自动为你上传,你还会获得一张精美的模型卡片。

该命令将输出两项内容:

从 Python 脚本

You can use the push function from Python. It returns a dictionary containing the "url" and ”whl_url” of the published model and the wheel file, which you can later install with pip install.

from spacy_huggingface_hub import push

result = push("./en_ner_fashion-0.0.0-py3-none-any.whl")
print(result["url"])

其他资源

Update on GitHub