加速推理

Sentence Transformers 支持 3 种用于计算嵌入的后端,每种都有其自己的优化,用于加速推理


PyTorch

PyTorch 后端是 Sentence Transformers 的默认后端。如果您未指定设备,它将使用“cuda”、“mps”和“cpu”中可用的最强选项。其默认用法如下:

from sentence_transformers import SentenceTransformer

model = SentenceTransformer("all-MiniLM-L6-v2")

sentences = ["This is an example sentence", "Each sentence is converted"]
embeddings = model.encode(sentences)

如果您正在使用 GPU,那么可以使用以下选项来加速推理:

Float32 (fp32,全精度) 是 torch 中的默认浮点格式,而 float16 (fp16,半精度) 是一种降低精度的浮点格式,可以以最小的模型精度损失加速 GPU 推理。要使用它,您可以在初始化时指定 torch_dtype 或在初始化模型上调用 model.half()

from sentence_transformers import SentenceTransformer

model = SentenceTransformer("all-MiniLM-L6-v2", model_kwargs={"torch_dtype": "float16"})
# or: model.half()

sentences = ["This is an example sentence", "Each sentence is converted"]
embeddings = model.encode(sentences)

Bfloat16 (bf16) 类似于 fp16,但保留了更多 fp32 的原始精度。要使用它,您可以在初始化时指定 torch_dtype 或在初始化模型上调用 model.bfloat16()

from sentence_transformers import SentenceTransformer

model = SentenceTransformer("all-MiniLM-L6-v2", model_kwargs={"torch_dtype": "bfloat16"})
# or: model.bfloat16()

sentences = ["This is an example sentence", "Each sentence is converted"]
embeddings = model.encode(sentences)

ONNX

ONNX 可以通过将模型转换为 ONNX 格式并使用 ONNX Runtime 运行模型来加速推理。要使用 ONNX 后端,您必须安装带有 onnxonnx-gpu 额外选项的 Sentence Transformers,分别用于 CPU 或 GPU 加速。

pip install sentence-transformers[onnx-gpu]
# or
pip install sentence-transformers[onnx]

要将模型转换为 ONNX 格式,您可以使用以下代码:

from sentence_transformers import SentenceTransformer

model = SentenceTransformer("all-MiniLM-L6-v2", backend="onnx")

sentences = ["This is an example sentence", "Each sentence is converted"]
embeddings = model.encode(sentences)

如果模型路径或仓库中已包含 ONNX 格式的模型,Sentence Transformers 将自动使用它。否则,它将把模型转换为 ONNX 格式。

注意

如果您希望在 Sentence Transformers 之外使用 ONNX 模型,则需要自行执行池化和/或归一化。ONNX 导出仅转换 Transformer 组件,该组件输出的是词元嵌入,而不是句子嵌入。要获取句子嵌入,您需要应用适当的池化策略(如均值池化)以及原始模型使用的任何归一化。

所有通过 model_kwargs 传递的关键字参数都将传递给 ORTModel.from_pretrained。一些值得注意的参数包括:

  • provider:用于加载模型的 ONNX Runtime 提供者,例如 "CPUExecutionProvider"。有关可能的提供者,请参阅 https://runtime.onnx.org.cn/docs/execution-providers/。如果未指定,将使用最强的提供者(例如 "CUDAExecutionProvider")。

  • file_name:要加载的 ONNX 文件的名称。如果未指定,将默认为 "model.onnx",否则为 "onnx/model.onnx"。此参数对于指定优化或量化模型很有用。

  • export:一个布尔标志,指定是否导出模型。如果未提供,如果模型仓库或目录中尚未包含 ONNX 模型,则 export 将设置为 True

提示

强烈建议保存导出的模型,以避免每次运行代码时都必须重新导出。如果您的模型是本地模型,可以通过调用 model.save_pretrained() 来实现

model = SentenceTransformer("path/to/my/model", backend="onnx")
model.save_pretrained("path/to/my/model")

或者如果您的模型来自 Hugging Face Hub,则使用 model.push_to_hub()

model = SentenceTransformer("intfloat/multilingual-e5-small", backend="onnx")
model.push_to_hub("intfloat/multilingual-e5-small", create_pr=True)

优化 ONNX 模型

ONNX 模型可以使用 Optimum 进行优化,从而在 CPU 和 GPU 上都能加速。为此,您可以使用 export_optimized_onnx_model() 函数,该函数将优化后的模型保存在您指定的目录或模型仓库中。它需要:

  • model:使用 ONNX 后端加载的 Sentence Transformer 或 Cross Encoder 模型。

  • optimization_config"O1""O2""O3""O4",表示来自 AutoOptimizationConfig 的优化级别,或一个 OptimizationConfig 实例。

  • model_name_or_path:保存优化模型文件的路径,如果您想将其推送到 Hugging Face Hub,则是仓库名称。

  • push_to_hub:(可选)一个布尔值,用于将优化模型推送到 Hugging Face Hub。

  • create_pr:(可选)一个布尔值,用于在推送到 Hugging Face Hub 时创建拉取请求。当您没有仓库的写入权限时很有用。

  • file_suffix:(可选)一个字符串,附加到模型名称后保存。如果未指定,将使用优化级别名称字符串,如果优化配置不是简单的字符串优化级别,则仅使用 "optimized"

请参阅此示例,了解如何使用优化级别 3(基本和扩展通用优化、transformers 专用融合、快速 Gelu 近似)导出模型:

只优化一次

from sentence_transformers import SentenceTransformer, export_optimized_onnx_model

model = SentenceTransformer("all-MiniLM-L6-v2", backend="onnx")
export_optimized_onnx_model(
    model,
    "O3",
    "sentence-transformers/all-MiniLM-L6-v2",
    push_to_hub=True,
    create_pr=True,
)

在拉取请求合并之前

from sentence_transformers import SentenceTransformer

pull_request_nr = 2 # TODO: Update this to the number of your pull request
model = SentenceTransformer(
    "all-MiniLM-L6-v2",
    backend="onnx",
    model_kwargs={"file_name": "onnx/model_O3.onnx"},
    revision=f"refs/pr/{pull_request_nr}"
)

拉取请求合并后

from sentence_transformers import SentenceTransformer

model = SentenceTransformer(
    "all-MiniLM-L6-v2",
    backend="onnx",
    model_kwargs={"file_name": "onnx/model_O3.onnx"},
)

只优化一次

from sentence_transformers import SentenceTransformer, export_optimized_onnx_model

model = SentenceTransformer("path/to/my/mpnet-legal-finetuned", backend="onnx")
export_optimized_onnx_model(model, "O3", "path/to/my/mpnet-legal-finetuned")

优化后

from sentence_transformers import SentenceTransformer

model = SentenceTransformer(
    "path/to/my/mpnet-legal-finetuned",
    backend="onnx",
    model_kwargs={"file_name": "onnx/model_O3.onnx"},
)

量化 ONNX 模型

ONNX 模型可以使用 Optimum 量化为 int8 精度,从而在 CPU 上实现更快的推理。为此,您可以使用 export_dynamic_quantized_onnx_model() 函数,该函数将量化后的模型保存在您指定的目录或模型仓库中。动态量化与静态量化不同,不需要校准数据集。它需要:

  • model:使用 ONNX 后端加载的 Sentence Transformer 或 Cross Encoder 模型。

  • quantization_config"arm64""avx2""avx512""avx512_vnni",表示来自 AutoQuantizationConfig 的量化配置,或一个 QuantizationConfig 实例。

  • model_name_or_path:保存量化模型文件的路径,如果您想将其推送到 Hugging Face Hub,则是仓库名称。

  • push_to_hub:(可选)一个布尔值,用于将量化模型推送到 Hugging Face Hub。

  • create_pr:(可选)一个布尔值,用于在推送到 Hugging Face Hub 时创建拉取请求。当您没有仓库的写入权限时很有用。

  • file_suffix:(可选)一个字符串,附加到模型名称后保存。如果未指定,将使用 "qint8_quantized"

在我的 CPU 上,每个默认的量化配置("arm64""avx2""avx512""avx512_vnni")都带来了大致相同的加速效果。

请参阅此示例,了解如何使用avx512_vnni 将模型量化为 int8

只量化一次

from sentence_transformers import SentenceTransformer, export_dynamic_quantized_onnx_model

model = SentenceTransformer("all-MiniLM-L6-v2", backend="onnx")
export_dynamic_quantized_onnx_model(
    model,
    "avx512_vnni",
    "sentence-transformers/all-MiniLM-L6-v2",
    push_to_hub=True,
    create_pr=True,
)

在拉取请求合并之前

from sentence_transformers import SentenceTransformer

pull_request_nr = 2 # TODO: Update this to the number of your pull request
model = SentenceTransformer(
    "all-MiniLM-L6-v2",
    backend="onnx",
    model_kwargs={"file_name": "onnx/model_qint8_avx512_vnni.onnx"},
    revision=f"refs/pr/{pull_request_nr}",
)

拉取请求合并后

from sentence_transformers import SentenceTransformer

model = SentenceTransformer(
    "all-MiniLM-L6-v2",
    backend="onnx",
    model_kwargs={"file_name": "onnx/model_qint8_avx512_vnni.onnx"},
)

只量化一次

from sentence_transformers import SentenceTransformer, export_dynamic_quantized_onnx_model

model = SentenceTransformer("path/to/my/mpnet-legal-finetuned", backend="onnx")
export_dynamic_quantized_onnx_model(model, "O3", "path/to/my/mpnet-legal-finetuned")

量化后

from sentence_transformers import SentenceTransformer

model = SentenceTransformer(
    "path/to/my/mpnet-legal-finetuned",
    backend="onnx",
    model_kwargs={"file_name": "onnx/model_qint8_avx512_vnni.onnx"},
)

OpenVINO

OpenVINO 允许通过将模型导出为 OpenVINO 格式来加速 CPU 上的推理。要使用 OpenVINO 后端,您必须安装带有 openvino 额外选项的 Sentence Transformers。

pip install sentence-transformers[openvino]

要将模型转换为 OpenVINO 格式,您可以使用以下代码:

from sentence_transformers import SentenceTransformer

model = SentenceTransformer("all-MiniLM-L6-v2", backend="openvino")

sentences = ["This is an example sentence", "Each sentence is converted"]
embeddings = model.encode(sentences)

如果模型路径或仓库中已包含 OpenVINO 格式的模型,Sentence Transformers 将自动使用它。否则,它将把模型转换为 OpenVINO 格式。

注意

如果您希望在 Sentence Transformers 之外使用 OpenVINO 模型,则需要自行执行池化和/或归一化。OpenVINO 导出仅转换 Transformer 组件,该组件输出的是词元嵌入,而不是句子嵌入。要获取句子嵌入,您需要应用适当的池化策略(如均值池化)以及原始模型使用的任何归一化。

所有通过 model_kwargs 传递的关键字参数都将传递给 OVBaseModel.from_pretrained()。一些值得注意的参数包括:
  • file_name:要加载的 ONNX 文件的名称。如果未指定,将默认为 "openvino_model.xml",否则为 "openvino/openvino_model.xml"。此参数对于指定优化或量化模型很有用。

  • export:一个布尔标志,指定是否导出模型。如果未提供,如果模型仓库或目录中尚未包含 OpenVINO 模型,则 export 将设置为 True

提示

强烈建议保存导出的模型,以避免每次运行代码时都必须重新导出。如果您的模型是本地模型,可以通过调用 model.save_pretrained() 来实现

model = SentenceTransformer("path/to/my/model", backend="openvino")
model.save_pretrained("path/to/my/model")

或者如果您的模型来自 Hugging Face Hub,则使用 model.push_to_hub()

model = SentenceTransformer("intfloat/multilingual-e5-small", backend="openvino")
model.push_to_hub("intfloat/multilingual-e5-small", create_pr=True)

量化 OpenVINO 模型

OpenVINO 模型可以使用 Optimum Intel 量化为 int8 精度以加速推理。为此,您可以使用 export_static_quantized_openvino_model() 函数,该函数将量化后的模型保存在您指定的目录或模型仓库中。训练后静态量化需要:

  • quantization_config:(可选)量化配置。此参数接受:None 表示默认的 8 位量化、表示量化配置的字典或 OVQuantizationConfig 实例。

  • dataset_name:(可选)要加载进行校准的数据集名称。如果未指定,默认为 glue 数据集中的 sst2 子集。

  • model_name_or_path:保存量化模型文件的路径,如果您想将其推送到 Hugging Face Hub,则是仓库名称。

  • dataset_config_name:(可选)要加载的数据集的特定配置。

  • dataset_split:(可选)要加载的数据集拆分(例如,“train”、“test”)。

  • column_name:(可选)数据集中用于校准的列名。

  • 请参阅此示例,了解如何使用静态量化将模型量化为 int8

  • push_to_hub:(可选)一个布尔值,用于将量化模型推送到 Hugging Face Hub。

  • create_pr:(可选)一个布尔值,用于在推送到 Hugging Face Hub 时创建拉取请求。当您没有仓库的写入权限时很有用。

  • file_suffix:(可选)一个字符串,附加到模型名称后保存。如果未指定,将使用 "qint8_quantized"

基准测试

只量化一次

from sentence_transformers import SentenceTransformer, export_static_quantized_openvino_model

model = SentenceTransformer("all-MiniLM-L6-v2", backend="openvino")
export_static_quantized_openvino_model(
    model,
    quantization_config=None,
    model_name_or_path="sentence-transformers/all-MiniLM-L6-v2",
    push_to_hub=True,
    create_pr=True,
)

在拉取请求合并之前

from sentence_transformers import SentenceTransformer

pull_request_nr = 2 # TODO: Update this to the number of your pull request
model = SentenceTransformer(
    "all-MiniLM-L6-v2",
    backend="openvino",
    model_kwargs={"file_name": "openvino/openvino_model_qint8_quantized.xml"},
    revision=f"refs/pr/{pull_request_nr}"
)

拉取请求合并后

from sentence_transformers import SentenceTransformer

model = SentenceTransformer(
    "all-MiniLM-L6-v2",
    backend="openvino",
    model_kwargs={"file_name": "openvino/openvino_model_qint8_quantized.xml"},
)

只量化一次

from sentence_transformers import SentenceTransformer, export_static_quantized_openvino_model
from optimum.intel import OVQuantizationConfig

model = SentenceTransformer("path/to/my/mpnet-legal-finetuned", backend="openvino")
quantization_config = OVQuantizationConfig()
export_static_quantized_openvino_model(model, quantization_config, "path/to/my/mpnet-legal-finetuned")

量化后

from sentence_transformers import SentenceTransformer

model = SentenceTransformer(
    "path/to/my/mpnet-legal-finetuned",
    backend="openvino",
    model_kwargs={"file_name": "openvino/openvino_model_qint8_quantized.xml"},
)

下图显示了不同后端在 GPU 和 CPU 上的基准测试结果。结果是根据 4 种不同大小的模型、3 个数据集和多种批量大小的平均值。

展开基准测试详情

加速比
硬件:RTX 3090 GPU,i7-17300K CPU语义文本相似度:基于 sentence-transformers/stsb 测试集上的余弦相似度计算的 Spearman 秩相关系数,通过 EmbeddingSimilarityEvaluator 计算。
  • 评估
    • 信息检索:基于 NanoBEIR 整个数据集集合上的余弦相似度计算的 NDCG@10,通过 InformationRetrievalEvaluator 计算。
    • 后端
  • torch-fp32:PyTorch 使用 float32 精度(默认)。
    • torch-fp16:PyTorch 使用 float16 精度,通过 model_kwargs={"torch_dtype": "float16"}
    • torch-bf16:PyTorch 使用 bfloat16 精度,通过 model_kwargs={"torch_dtype": "bfloat16"}
    • onnx:ONNX 使用 float32 精度,通过 backend="onnx"
    • onnx-O1:ONNX 使用 float32 精度和 O1 优化,通过 export_optimized_onnx_model(..., "O1", ...)backend="onnx"
    • onnx-O2:ONNX 使用 float32 精度和 O2 优化,通过 export_optimized_onnx_model(..., "O2", ...)backend="onnx"
    • onnx-O3:ONNX 使用 float32 精度和 O3 优化,通过 export_optimized_onnx_model(..., "O3", ...)backend="onnx"
    • onnx-O4:ONNX 使用 float16 精度和 O4 优化,通过 export_optimized_onnx_model(..., "O4", ...)backend="onnx"
    • onnx-qint8:ONNX 量化为 int8,使用 "avx512_vnni",通过 export_dynamic_quantized_onnx_model(..., "avx512_vnni", ...)backend="onnx"。不同的量化配置产生了大致相同的加速效果。
    • openvino:OpenVINO,通过 backend="openvino"
    • openvino-qint8:OpenVINO 量化为 int8,通过 export_static_quantized_openvino_model(..., OVQuantizationConfig(), ...)backend="openvino"
    • 请注意,对模型、数据集和批量大小的积极平均阻止了一些更复杂的模式变得可见。例如,对于 GPU,如果我们只考虑文本最短的 stsb 数据集,ONNX 变得更好:ONNX 为 1.46 倍,ONNX-O4 达到 1.83 倍,而 fp16 和 bf16 分别达到 1.54 倍和 1.53 倍。因此,对于较短的文本,我们建议在 GPU 上使用 ONNX。
对于 CPU,ONNX 对于文本最短的 stsb 数据集也更强:ONNX 为 1.39 倍,优于 OpenVINO 的 1.29 倍。int8 量化的 ONNX 甚至更强,速度提升了 3.08 倍。对于较长的文本,ONNX 和 OpenVINO 的性能甚至可能略低于 PyTorch,因此我们建议使用您的特定模型和数据测试不同的后端,以找到最适合您用例的后端。

建议

Benchmark for GPUs Benchmark for CPUs

根据基准测试结果,此流程图应该能帮助您决定使用哪个后端来处理您的模型

您的实际效果可能有所不同,您应该始终使用您的特定模型和数据测试不同的后端,以找到最适合您用例的后端。

注意

用户界面

此 Hugging Face Space 提供了一个用户界面,用于导出、优化和量化 ONNX 或 OpenVINO 模型