Transformers 文档

将 🤗 Transformers 模型导出到 ONNX

Hugging Face's logo
加入 Hugging Face 社区

并获得增强文档体验

开始使用

将 🤗 Transformers 模型导出到 ONNX

🤗 Transformers 提供了一个 transformers.onnx 包,使您能够通过利用配置对象将模型检查点转换为 ONNX 图。

有关导出 🤗 Transformers 模型的更多详细信息,请参阅指南

ONNX 配置

我们提供了三个抽象类,您应该根据要导出的模型架构类型继承它们

OnnxConfig

transformers.onnx.OnnxConfig

< >

( config: PretrainedConfig task: str = 'default' patching_specs: List = None )

用于 ONNX 可导出模型的基类,描述了如何通过 ONNX 格式导出模型的元数据。

flatten_output_collection_property

< >

( name: str field: Iterable ) (Dict[str, Any])

返回

(Dict[str, Any])

具有扁平化结构和映射此新结构的键的输出。

展平任何潜在的嵌套结构,并使用结构中元素的索引扩展字段的名称。

from_model_config

< >

( config: PretrainedConfig task: str = 'default' )

为特定模型实例化 OnnxConfig

generate_dummy_inputs

< >

( preprocessor: Union batch_size: int = -1 seq_length: int = -1 num_choices: int = -1 is_pair: bool = False framework: Optional = None num_channels: int = 3 image_width: int = 40 image_height: int = 40 sampling_rate: int = 22050 time_duration: float = 5.0 frequency: int = 220 tokenizer: PreTrainedTokenizerBase = None )

参数

  • batch_size (int可选,默认为 -1) — 导出模型的批量大小(-1 表示动态轴)。
  • num_choices (int可选,默认为 -1) — 为多选任务提供的候选答案数量(-1 表示动态轴)。
  • seq_length (int可选,默认为 -1) — 导出模型的序列长度(-1 表示动态轴)。
  • is_pair (bool可选,默认为 False) — 指示输入是否为一对(句子 1,句子 2)
  • framework (TensorType可选,默认为 None) — 分词器将为其生成张量的框架(PyTorch 或 TensorFlow)。
  • num_channels (int可选,默认为 3) — 生成图像的通道数。
  • image_width (int可选,默认为 40) — 生成图像的宽度。
  • image_height (int可选,默认为 40) — 生成图像的高度。
  • sampling_rate (int可选,默认为 22050) — 用于生成音频数据的采样率。
  • time_duration (float可选,默认为 5.0) — 用于生成音频数据的总采样秒数。
  • frequency (int可选,默认为 220) — 生成的音频所需的自然频率。

生成要提供给特定框架的 ONNX 导出器的输入

generate_dummy_inputs_onnxruntime

< >

( reference_model_inputs: Mapping ) Mapping[str, Tensor]

参数

  • reference_model_inputs ([Mapping[str, Tensor]) — 模型的参考输入。

返回

Mapping[str, Tensor]

包含要提供给模型前向函数的关键字参数的映射

使用参考模型输入为 ONNX Runtime 生成输入。 覆盖此方法以使用 seq2seq 模型运行推理,这些模型的编码器和解码器作为单独的 ONNX 文件导出。

use_external_data_format

< >

( num_parameters: int )

指示模型是否需要使用外部数据格式的标志

OnnxConfigWithPast

transformers.onnx.OnnxConfigWithPast

< >

( config: PretrainedConfig task: str = 'default' patching_specs: List = None use_past: bool = False )

fill_with_past_key_values_

< >

( inputs_or_outputs: Mapping direction: str inverted_values_shape: bool = False )

使用 past_key_values 动态轴填充 input_or_outputs 映射。

with_past

< >

( config: PretrainedConfig task: str = 'default' )

实例化一个 use_past 属性设置为 True 的 OnnxConfig

OnnxSeq2SeqConfigWithPast

transformers.onnx.OnnxSeq2SeqConfigWithPast

< >

( config: PretrainedConfig task: str = 'default' patching_specs: List = None use_past: bool = False )

ONNX 功能

每个 ONNX 配置都与一组*功能*相关联,这些功能使您能够导出用于不同类型拓扑或任务的模型。

FeaturesManager

transformers.onnx.FeaturesManager

< >

( )

check_supported_model_or_raise

< >

( model: Union feature: str = 'default' )

检查模型是否具有请求的功能。

determine_framework

< >

( model: str framework: str = None )

参数

  • model (str) — 要导出的模型名称。
  • framework (str, 可选, 默认为 None) — 用于导出的框架。如果未提供,请参阅上面的优先级。

确定用于导出的框架。

优先级顺序如下

  1. 用户通过 framework 输入。
  2. 如果提供了本地检查点,则使用与检查点相同的框架。
  3. 环境中可用的框架,优先考虑 PyTorch

get_config

< >

( model_type: str feature: str ) OnnxConfig

参数

  • model_type (str) — 要检索其配置的模型类型。
  • feature (str) — 要检索其配置的功能。

返回

OnnxConfig

组合的配置

获取 model_type 和 feature 组合的 OnnxConfig。

get_model_class_for_feature

< >

( feature: str framework: str = 'pt' )

参数

  • feature (str) — 所需的功能。
  • framework (str, 可选, 默认为 "pt") — 用于导出的框架。

尝试从功能名称检索 AutoModel 类。

get_model_from_feature

< >

( feature: str model: str framework: str = None cache_dir: str = None )

参数

  • feature (str) — 所需的功能。
  • model (str) — 要导出的模型名称。
  • framework (str, 可选, 默认为 None) — 用于导出的框架。 如果未提供,请参阅 FeaturesManager.determine_framework 了解优先级。

尝试从模型名称和要启用的功能检索模型。

get_supported_features_for_model_type

< >

( model_type: str model_name: Optional = None )

参数

  • model_type (str) — 要检索其支持特性的模型类型。
  • model_name (str, 可选) — 模型对象的名称属性,仅用于异常消息。

尝试从模型类型中检索特性 -> OnnxConfig 构造函数映射。

< > 在 GitHub 上更新