Optimum 文档

概述

您正在查看 main 版本,该版本需要从源代码安装. 如果您想要常规 pip 安装,请查看最新的稳定版本 (v1.24.0)。
Hugging Face's logo
加入 Hugging Face 社区

并获得增强的文档体验

开始使用

概述

🤗 Optimum 提供了一个名为 BetterTransformer 的 API,它是标准 PyTorch Transformer API 的快速路径,通过稀疏性和融合内核(如 Flash Attention)在 CPU 和 GPU 上获得令人感兴趣的加速。目前,BetterTransformer 支持来自原生 nn.TransformerEncoderLayer 以及来自 torch.nn.functional.scaled_dot_product_attention 的 Flash Attention 和 Memory-Efficient Attention 的快速路径。

快速入门

自 1.13 版本以来,PyTorch 发布了 其标准 Transformer API 快速路径的稳定版本,该版本为基于 Transformer 的模型提供了开箱即用的性能改进。您可以在大多数消费级设备(包括 CPU、新旧版本的 NVIDIA GPU)上获得令人感兴趣的加速。您现在可以在 🤗 Optimum 中与 Transformers 一起使用此功能,并将其用于 Hugging Face 生态系统中的主要模型。

在 2.0 版本中,PyTorch 包含一个原生的 scaled dot-product attention 运算符 (SDPA) 作为 torch.nn.functional 的一部分。此函数包含多个实现,可以根据输入和使用的硬件应用。有关更多信息,请参阅 官方文档,以及 此博客文章 以获取基准测试。

我们在 🤗 Optimum 中提供了与这些优化的开箱即用集成,以便您可以转换任何受支持的 🤗 Transformers 模型,从而在相关时使用优化的路径和 scaled_dot_product_attention 函数。

PyTorch 原生 `scaled_dot_product_attention` 正在慢慢地原生 [成为默认设置并集成到 🤗 Transformers](https://huggingface.co/docs/transformers/perf_infer_gpu_one#flashattention-and-memory-efficient-attention-through-pytorchs-scaleddotproductattention) 中。对于在 Transformers 中支持 SDPA 的模型,我们弃用 BetterTransformer,并建议您直接使用 Transformers 和 PyTorch 最新版本,以通过 SDPA 实现注意力优化(Flash Attention,memory-efficient attention)。
PyTorch 原生 `scaled_dot_product_attention` 运算符只有在未提供 `attention_mask` 时才能调度到 Flash Attention。

因此,默认情况下,在训练模式下,BetterTransformer 集成放弃了掩码支持,只能用于不需要填充掩码进行批量训练的训练。例如,掩码语言建模或因果语言建模就是这种情况。 BetterTransformer 不适用于在需要填充掩码的任务上微调模型。

在推理模式下,填充掩码被保留以确保正确性,因此只有在批量大小 = 1 的情况下才应预期加速。

支持的模型

以下是支持的模型列表

如果您希望支持更多模型,请在 🤗 Optimum 中提出 issue 让我们知道,或者如果您想自己添加,请查看贡献指南

快速使用

为了使用 BetterTransformer API,只需运行以下命令

>>> from transformers import AutoModelForSequenceClassification
>>> from optimum.bettertransformer import BetterTransformer
>>> model_hf = AutoModelForSequenceClassification.from_pretrained("bert-base-cased")
>>> model = BetterTransformer.transform(model_hf, keep_original_model=True)

如果您想使用 BetterTransformer 版本覆盖当前模型,可以保留 keep_original_model=False

有关如何深入理解其使用的更多详细信息,请查看 tutorials 部分,或查看 Google colab 演示

< > 在 GitHub 上更新