Transformers 文档
将 🤗 Transformers 模型导出至 ONNX
并获得增强的文档体验
开始使用
将 🤗 Transformers 模型导出至 ONNX
🤗 Transformers 提供了一个 transformers.onnx 包，您可以通过利用配置对象将模型检查点转换为 ONNX 图。
更多详情请参见有关导出 🤗 Transformers 模型的指南。
ONNX 配置
我们提供了三个抽象类，您应根据希望导出的模型架构类型继承这些类
- 基于编码器的模型继承自 OnnxConfig
- 基于解码器的模型继承自 OnnxConfigWithPast
- 编码器-解码器模型继承自 OnnxSeq2SeqConfigWithPast
OnnxConfig
class transformers.onnx.OnnxConfig
< 来源 >( config: PretrainedConfig task: str = 'default' patching_specs: typing.Optional[list[transformers.onnx.config.PatchingSpec]] = None )
ONNX 可导出模型的基类，描述了如何通过 ONNX 格式导出模型的元数据。
flatten_output_collection_property
< 来源 >( name: str field: Iterable ) → (dict[str, Any])
将任何潜在的嵌套结构扁平化，通过结构内元素的索引来扩展字段名称。
from_model_config
< 来源 >( config: PretrainedConfig task: str = 'default' )
为特定模型实例化一个 OnnxConfig
生成虚拟输入
< 来源 >( preprocessor: typing.Union[ForwardRef('PreTrainedTokenizerBase'), ForwardRef('FeatureExtractionMixin'), ForwardRef('ImageProcessingMixin')] batch_size: int = -1 seq_length: int = -1 num_choices: int = -1 is_pair: bool = False framework: typing.Optional[transformers.utils.generic.TensorType] = 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: typing.Optional[ForwardRef('PreTrainedTokenizerBase')] = None )
参数
- preprocessor — (PreTrainedTokenizerBase, FeatureExtractionMixin 或 ImageProcessingMixin): 与此模型配置关联的预处理器。
- 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]
使用参考模型输入为 ONNX Runtime 生成输入。对于编码器和解码器作为独立 ONNX 文件导出的 seq2seq 模型，可以重写此方法以运行推理。
指示模型是否需要使用外部数据格式的标志
OnnxConfigWithPast
class transformers.onnx.OnnxConfigWithPast
< 来源 >( config: PretrainedConfig task: str = 'default' patching_specs: typing.Optional[list[transformers.onnx.config.PatchingSpec]] = 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' )
实例化一个 OnnxConfig，其 `use_past` 属性设置为 True
OnnxSeq2SeqConfigWithPast
class transformers.onnx.OnnxSeq2SeqConfigWithPast
< 来源 >( config: PretrainedConfig task: str = 'default' patching_specs: typing.Optional[list[transformers.onnx.config.PatchingSpec]] = None use_past: bool = False )
ONNX 特性
每个 ONNX 配置都与一组 *特性* 相关联，使您能够为不同类型的拓扑或任务导出模型。
FeaturesManager
check_supported_model_or_raise
< 来源 >( model: typing.Union[ForwardRef('PreTrainedModel'), ForwardRef('TFPreTrainedModel')] feature: str = 'default' )
检查模型是否具有请求的特性。
determine_framework
< 来源 >( model: str framework: typing.Optional[str] = None )
确定用于导出的框架。
优先级顺序如下
- 通过 `framework` 的用户输入。
- 如果提供了本地检查点，则使用与检查点相同的框架。
- 环境中的可用框架，优先使用 PyTorch
get_config
< 来源 >( model_type: str feature: str ) → OnnxConfig
获取 model_type 和 feature 组合的 OnnxConfig。
get_model_class_for_feature
< 来源 >( feature: str framework: str = 'pt' )
尝试从特性名称中检索 AutoModel 类。
get_model_from_feature
< 源代码 >( feature: str model: str framework: typing.Optional[str] = None cache_dir: typing.Optional[str] = None )
尝试从模型名称和要启用的特性中检索模型。
get_supported_features_for_model_type
< 源代码 >( model_type: str model_name: typing.Optional[str] = None )
尝试从模型类型中检索 特性 -> OnnxConfig 构造函数的映射。