此页面由 AI 自动翻译。查看英文原版
最后更新

本页目录

  • 转换参数
  • 通用参数
  • YOLO 参数
  • 模型参数
  • 模型变体参数
  • 模型实例参数
  • RVC2 参数
  • RVC3 参数
  • RVC4 参数
  • Hailo 参数
  • 函数
  • convert
  • Hailo
  • RVC2
  • RVC3
  • RVC4
最后更新
Python API: hubai_sdk.services.convert运行托管模型转换并下载可部署的工件。目标特定辅助函数 RVC2、RVC3、RVC4 和 Hailo 是推荐的转换 API。每个辅助函数都会准备目标选项并委托给 convert,后者协调完整的 HubAI 工作流程:
  1. 从模型文件、YAML 配置或 NN Archive 读取模型元数据。
  2. 创建或重用模型和变体资源。
  3. 将源模型作为实例上传。
  4. 启动导出作业并等待其完成。
  5. 下载导出的实例。
  • 输入配置::path 可以指向模型文件、NN Archive 或 YAML 配置。附加的 opts 会覆盖从该配置加载的值。在 Python 中,字典通常最简单;平面列表形式用于命令行界面。
  • 资源重用::传递 model_id 或 variant_id 以将转换附加到现有资源。如果没有它们,convert 会创建资源并重用具有相同 slug 的模型(如果已存在)。
  • 量化::RVC4 和 Hailo 接受内置校准域、以 aid_ 开头的数据集 ID 或本地 ZIP 文件。传递 ZIP 路径会将其上传以进行导出作业。RVC2 和 RVC3 会忽略量化输入,因为这些辅助函数会公开其平台特定的精度控制。

转换参数

转换 API 接受输入、HubAI 资源和所选目标的参数。下面的函数签名提供了确切的类型和默认值;此概述按用途对参数进行分组。

通用参数

  • path:输入模型文件、YAML 配置或 NN Archive。
  • tool_version:转换工具的版本。
  • quantization_mode:RVC4 量化模式。FP16_STANDARD 跳过校准。
  • output_dir:下载输出文件的目录。如果省略,下载器会在当前工作目录中创建一个以导出实例 slug 命名的目录。

YOLO 参数

  • yolo_input_shape:YOLO 输入形状。如果省略或无效,则默认为 [640, 640]。
  • yolo_version:YOLO 版本,例如 "yolov8"。优先使用自动检测,仅在检测失败时设置此项。
  • yolo_class_names:模型类名。

模型参数

除非提供了 model_id,否则这些参数会创建一个 HubAI 模型资源。
  • model_id:要重用的现有模型的 ID。
  • name:模型名称。默认为配置或输入模型名称。
  • license_type:模型的许可证类型。
  • is_public:模型是公共的、私有的还是团队范围的。
  • description 和 description_short:模型的完整和简短描述。简短描述默认为 "<empty>"。
  • architecture_id:模型架构 ID。
  • tasks:模型支持的任务。
  • links:模型的附加链接。
  • is_yolo:模型是否为 YOLO 模型。

模型变体参数

  • model_id:要添加变体的现有模型的 ID。
  • variant_version:模型变体的版本。如果省略,HubAI 会自动使用下一个版本。
  • variant_description:完整的变体描述。
  • repository_url 和 commit_hash:相关的存储库 URL 和提交。
  • domain:变体域。
  • variant_tags:变体标签。

模型实例参数

  • variant_id:要重用的现有模型变体的 ID。
  • quantization_data:预定义的校准域、aid_ 数据集 ID 或本地自定义 .zip 路径。传递 ZIP 路径而不是 CUSTOM。
  • max_quantization_images:用于量化的最大图像数量。
  • instance_tags:模型实例标签。
  • input_shape:模型输入形状。
  • is_deployable:模型实例是否可部署。

RVC2 参数

  • mo_args:模型优化器的参数。
  • compile_tool_args:BLOB 编译器的参数。
  • compress_to_fp16:是否将模型权重压缩为 FP16。默认为 True。
  • number_of_shaves:要使用的 shaves 数量。默认为 8。
  • superblob:是否创建 superblob。默认为 True;禁用它以使用旧版 RVC2 转换。

RVC3 参数

  • mo_args:模型优化器的参数。
  • compile_tool_args:BLOB 编译器的参数。
  • compress_to_fp16:是否将模型权重压缩为 FP16。默认为 True。
  • pot_target_device:训练后优化的目标设备。默认为 "VPU"。

RVC4 参数

  • snpe_onnx_to_dlc_args:snpe-onnx-to-dlc 的参数。
  • snpe_dlc_quant_args:snpe-dlc-quant 的参数。
  • snpe_dlc_graph_prepare_args:snpe-dlc-graph-prepare 的参数。
  • use_per_channel_quantization:是否使用逐通道量化。默认为 True。
  • use_per_row_quantization:是否使用逐行量化。默认为 False。
  • htp_socs:要使用的 HTP SoC。默认为 ["sm8550"]。

Hailo 参数

  • optimization_level:优化级别。默认为 2。
  • compression_level:压缩级别。默认为 2。
  • batch_size:量化批次大小。默认为 8。
  • alls:附加的 ALLS 参数。

函数

convert

Python
1def convert(target: Target, opts: list[str] | None = None, /, *, path: str, name: str | None = None, license_type: License = 'undefined', is_public: bool | None = False, description_short: str = '<empty>', description: str | None = None, architecture_id: UUID | str | None = None, tasks: list[Task] | None = None, links: list[str] | None = None, is_yolo: bool = False, model_id: UUID | str | None = None, variant_version: str | None = None, variant_description: str | None = None, repository_url: str | None = None, commit_hash: str | None = None, quantization_mode: QuantizationMode | None = None, domain: str | None = None, variant_tags: list[str] | None = None, variant_id: UUID | str | None = None, quantization_data: QuantizationData | PathType | None = None, max_quantization_images: int | None = None, instance_tags: list[str] | None = None, input_shape: list[int] | None = None, is_deployable: bool | None = None, output_dir: str | None = None, tool_version: str | None = None, yolo_input_shape: list[int] | None = None, yolo_version: YoloVersion | None = None, yolo_class_names: list[str] | None = None) -> ConvertResponse:
启动在线转换过程。参数
  • target (Target):目标平台。
  • opts (list[str] | None):转换过程的附加选项。
  • path (str):输入模型文件、NN Archive 或 YAML 配置文件的路径。
  • name (str | None):模型名称。如果未指定,则从配置文件或模型文件中获取名称。
  • license_type (License):新创建模型的许可证类型。
  • is_public (bool | None):模型是公共的 (True)、私有的 (False) 还是团队范围的 (None)。
  • description_short (str):模型的简短描述。默认为 "<empty>"。
  • description (str | None):模型的完整描述。
  • architecture_id (UUID | str | None):架构 ID。
  • tasks (list[Task] | None):模型支持的任务。
  • links (list[str] | None):模型的附加链接。
  • is_yolo (bool):模型是否为 YOLO 模型。
  • model_id (UUID | str | None):现有模型资源的 ID。如果指定,则使用该模型而不是创建新模型。
  • variant_version (str | None):模型版本。如果未指定,则版本会从模型的最新版本自动递增。如果不存在任何版本,则版本为 "0.1.0"。
  • variant_description (str | None):模型变体的完整描述。
  • repository_url (str | None):存储库的 URL。
  • commit_hash (str | None):提交哈希。
  • quantization_mode (QuantizationMode | None):在 RVC4 转换期间使用的量化模式。必须是 INT8_STANDARD、INT8_ACCURACY_FOCUSED、INT8_INT16_MIXED、INT8_INT16_MIXED_ACCURACY_FOCUSED 或 FP16_STANDARD 之一。INT8_STANDARD 是标准的 INT8 量化,带有校准,可实现最佳性能和模型大小。INT8_ACCURACY_FOCUSED 是带有校准的 INT8 量化,可以提高准确性,而不会降低性能或增加模型大小,具体取决于模型。INT8_INT16_MIXED 在所有层中使用 8 位权重和 16 位激活,以提高数值稳定性和准确性,但会牺牲性能和模型大小。INT8_INT16_MIXED_ACCURACY_FOCUSED 是一种基于校准的混合 INT8 和 INT16 模式,优先考虑准确性而不是吞吐量。FP16_STANDARD 是 FP16 量化,没有校准,适用于需要更高准确性和数值稳定性的模型,但会牺牲性能和模型大小。FP16_STANDARD 跳过校准。
  • domain (str | None):模型变体的域。
  • variant_tags (list[str] | None):模型变体的标签。
  • variant_id (UUID | str | None):现有模型版本资源的 ID。如果指定,则使用该版本而不是创建新版本。
  • quantization_data (QuantizationData | PathType | None):用于量化此模型的数据。这可以是预定义的域 (DRIVING、FOOD、GENERAL、INDOORS、RANDOM、WAREHOUSE、CLIP、UNKNOWN)、数据集 ID 或本地量化 .zip 文件的路径。传递 .zip 路径本身而不是 CUSTOM;SDK 会自动规范化本地 zip 输入。
  • max_quantization_images (int | None):用于量化的最大图像数量。
  • instance_tags (list[str] | None):模型实例的标签。
  • input_shape (list[int] | None):模型实例的输入形状。
  • is_deployable (bool | None):模型实例是否可部署。
  • output_dir (str | None):下载文件的目录路径。如果未指定,下载器会在当前工作目录下创建一个以导出实例 slug 命名的目录。
  • tool_version (str | None):用于转换的工具版本。对于 RVC2 和 RVC3,这是 IR 版本,而对于 RVC4,这是 SNPE 版本。
  • yolo_input_shape (list[int] | None):YOLO 模型的输入形状。如果省略或无效,则默认为 [640, 640]。
  • yolo_version (YoloVersion | None):YOLO 版本,例如 "yolov8"。通常省略此项以使用自动检测;仅在检测失败时指定。
  • yolo_class_names (list[str] | None):YOLO 模型的类名。
返回
  • ConvertResponse:转换结果,包含下载的输出路径、导出作业和导出的模型实例。

Hailo

Python
1def Hailo(path: PathType, optimization_level: Literal[-100, 0, 1, 2, 3, 4] = 2, compression_level: Literal[0, 1, 2, 3, 4, 5] = 2, batch_size: int = 8, alls: list[str] | None = None, opts: Kwargs | list[str] | None = None, **hub_kwargs) -> ConvertResponse:
将模型转换为 Hailo 格式。参数
  • path (PathType):要转换的模型文件的路径。
  • optimization_level (Literal[-100, 0, 1, 2, 3, 4]):转换的优化级别。默认为 2。
  • compression_level (Literal[0, 1, 2, 3, 4, 5]):转换的压缩级别。默认为 2。
  • batch_size (int):量化的批次大小。默认为 8。
  • alls (list[str] | None):在转换期间应用的附加 Hailo ALLS 参数。
  • opts (Kwargs | list[str] | None):附加转换选项。这些可以覆盖配置值。
  • name:模型名称。如果未指定,则从配置文件或模型文件中获取名称。
  • license_type:许可证类型。
  • is_public:模型是公共的 (True)、私有的 (False) 还是团队范围的 (None)。
  • description_short:模型的简短描述。
  • description:模型的完整描述。
  • architecture_id:架构 ID。
  • tasks:此模型支持的任务。
  • links:相关资源的链接。
  • is_yolo:模型是否为 YOLO 模型。
  • model_id:现有模型资源的 ID。如果指定,则使用该模型而不是创建新模型。
  • variant_version:模型版本。如果未指定,则版本会从模型的最新版本自动递增。如果不存在任何版本,则版本为 "0.1.0"。
  • variant_description:模型变体的完整描述。
  • repository_url:存储库的 URL。
  • commit_hash:提交哈希。
  • quantization_mode:量化模式。
  • quantization_data:用于量化此模型的数据。这可以是预定义的域 (DRIVING、FOOD、GENERAL、INDOORS、RANDOM、WAREHOUSE、CLIP、UNKNOWN)、数据集 ID 或本地量化 .zip 文件的路径。
  • max_quantization_images:最大量化图像数量。
  • domain:模型的域。
  • variant_tags:模型变体的标签。
  • variant_id:现有模型版本资源的 ID。如果指定,则使用该版本而不是创建新版本。
  • input_shape:模型实例的输入形状。
  • is_deployable:模型实例是否可部署。
  • output_dir:下载文件的目录路径。如果未指定,下载器会在当前工作目录下创建一个以导出实例 slug 命名的目录。
  • tool_version:用于转换的工具版本。对于 RVC2 和 RVC3,这是 IR 版本,而对于 RVC4,这是 SNPE 版本。
  • yolo_input_shape:YOLO 模型的输入形状。
  • yolo_version:YOLO 版本。
  • yolo_class_names:YOLO 模型的类名。
  • **hub_kwargs:传递给 convert 的附加关键字参数。
返回
  • ConvertResponse:转换结果,包含下载的输出路径、导出作业和导出的模型实例。

RVC2

Python
1def RVC2(path: PathType, mo_args: list[str] | None = None, compile_tool_args: list[str] | None = None, compress_to_fp16: bool = True, number_of_shaves: int = 8, superblob: bool = True, opts: Kwargs | list[str] | None = None, **hub_kwargs) -> ConvertResponse:
将模型转换为 RVC2 格式。参数
  • path (PathType):要转换的模型文件的路径。
  • mo_args (list[str] | None):模型优化器的附加参数。
  • compile_tool_args (list[str] | None):编译工具的附加参数。
  • compress_to_fp16 (bool):是否将模型权重压缩为 FP16。默认为 True。
  • number_of_shaves (int):用于转换的 shaves 数量。默认为 8。
  • superblob (bool):是否为模型创建 superblob。默认为 True。禁用它以使用旧版 RVC2 转换。
  • opts (Kwargs | list[str] | None):附加转换选项。这些可以覆盖配置值。
  • name:模型名称。如果未指定,则从配置文件或模型文件中获取名称。
  • license_type:许可证类型。
  • is_public:模型是公共的 (True)、私有的 (False) 还是团队范围的 (None)。
  • description_short:模型的简短描述。
  • description:模型的完整描述。
  • architecture_id:架构 ID。
  • tasks:此模型支持的任务。
  • links:相关资源的链接。
  • is_yolo:模型是否为 YOLO 模型。
  • model_id:现有模型资源的 ID。如果指定,则使用该模型而不是创建新模型。
  • variant_version:模型版本。如果未指定,则版本会从模型的最新版本自动递增。如果不存在任何版本,则版本为 "0.1.0"。
  • variant_description:模型变体的完整描述。
  • repository_url:存储库的 URL。
  • commit_hash:提交哈希。
  • domain:模型的域。
  • variant_tags:模型变体的标签。
  • variant_id:现有模型版本资源的 ID。如果指定,则使用该版本而不是创建新版本。
  • input_shape:模型实例的输入形状。
  • is_deployable:模型实例是否可部署。
  • output_dir:下载文件的目录路径。如果未指定,下载器会在当前工作目录下创建一个以导出实例 slug 命名的目录。
  • tool_version:用于转换的工具版本。对于 RVC2 和 RVC3,这是 IR 版本,而对于 RVC4,这是 SNPE 版本。
  • yolo_input_shape:YOLO 模型的输入形状。
  • yolo_version:YOLO 版本。
  • yolo_class_names:YOLO 模型的类名。
  • **hub_kwargs:传递给 convert 的附加关键字参数。
返回
  • ConvertResponse:转换结果,包含下载的输出路径、导出作业和导出的模型实例。

RVC3

Python
1def RVC3(path: PathType, mo_args: list[str] | None = None, compile_tool_args: list[str] | None = None, compress_to_fp16: bool = True, pot_target_device: PotDevice | Literal['VPU', 'ANY'] = PotDevice.VPU, opts: Kwargs | list[str] | None = None, **hub_kwargs) -> ConvertResponse:
将模型转换为 RVC3 格式。参数
  • path (PathType):要转换的模型文件的路径。
  • mo_args (list[str] | None):模型优化器的附加参数。
  • compile_tool_args (list[str] | None):编译工具的附加参数。
  • compress_to_fp16 (bool):是否将模型权重压缩为 FP16。默认为 True。
  • pot_target_device (PotDevice | Literal['VPU', 'ANY']):训练后优化的目标设备。默认为 "VPU"。
  • opts (Kwargs | list[str] | None):附加转换选项。这些可以覆盖配置值。
  • name:模型名称。如果未指定,则从配置文件或模型文件中获取名称。
  • license_type:许可证类型。
  • is_public:模型是公共的 (True)、私有的 (False) 还是团队范围的 (None)。
  • description_short:模型的简短描述。
  • description:模型的完整描述。
  • architecture_id:架构 ID。
  • tasks:此模型支持的任务。
  • links:相关资源的链接。
  • is_yolo:模型是否为 YOLO 模型。
  • model_id:现有模型资源的 ID。如果指定,则使用该模型而不是创建新模型。
  • variant_version:模型版本。如果未指定,则版本会从模型的最新版本自动递增。如果不存在任何版本,则版本为 "0.1.0"。
  • variant_description:模型变体的完整描述。
  • repository_url:存储库的 URL。
  • commit_hash:提交哈希。
  • domain:模型的域。
  • variant_tags:模型变体的标签。
  • variant_id:现有模型版本资源的 ID。如果指定,则使用该版本而不是创建新版本。
  • input_shape:模型实例的输入形状。
  • is_deployable:模型实例是否可部署。
  • output_dir:下载文件的目录路径。如果未指定,下载器会在当前工作目录下创建一个以导出实例 slug 命名的目录。
  • tool_version:用于转换的工具版本。对于 RVC2 和 RVC3,这是 IR 版本,而对于 RVC4,这是 SNPE 版本。
  • yolo_input_shape:YOLO 模型的输入形状。
  • yolo_version:YOLO 版本。
  • yolo_class_names:YOLO 模型的类名。
  • **hub_kwargs:传递给 convert 的附加关键字参数。
返回
  • ConvertResponse:转换结果,包含下载的输出路径、导出作业和导出的模型实例。

RVC4

Python
1def RVC4(path: PathType, snpe_onnx_to_dlc_args: list[str] | None = None, snpe_dlc_quant_args: list[str] | None = None, snpe_dlc_graph_prepare_args: list[str] | None = None, use_per_channel_quantization: bool = True, use_per_row_quantization: bool = False, htp_socs: list[Literal['sm8350', 'sm8450', 'sm8550', 'sm8650', 'qcs6490', 'qcs8550']] | None = None, opts: Kwargs | list[str] | None = None, **hub_kwargs) -> ConvertResponse:
将模型转换为 RVC4 格式。参数
  • path (PathType):要转换的模型文件的路径。
  • snpe_onnx_to_dlc_args (list[str] | None):SNPE ONNX 到 DLC 转换的附加参数。
  • snpe_dlc_quant_args (list[str] | None):SNPE DLC 量化的附加参数。
  • snpe_dlc_graph_prepare_args (list[str] | None):SNPE DLC 图准备的附加参数。
  • use_per_channel_quantization (bool):是否使用逐通道量化。默认为 True。
  • use_per_row_quantization (bool):是否使用逐行量化。默认为 False。
  • htp_socs (list[Literal['sm8350', 'sm8450', 'sm8550', 'sm8650', 'qcs6490', 'qcs8550']] | None):最终 DLC 图的 HTP SoC。默认为 ["sm8550"]。
  • opts (Kwargs | list[str] | None):附加转换选项。这些可以覆盖配置值。
  • name:模型名称。如果未指定,则从配置文件或模型文件中获取名称。
  • license_type:许可证类型。
  • is_public:模型是公共的 (True)、私有的 (False) 还是团队范围的 (None)。
  • description_short:模型的简短描述。
  • description:模型的完整描述。
  • architecture_id:架构 ID。
  • tasks:此模型支持的任务。
  • links:相关资源的链接。
  • is_yolo:模型是否为 YOLO 模型。
  • model_id:现有模型资源的 ID。如果指定,则使用该模型而不是创建新模型。
  • variant_version:模型版本。如果未指定,则版本会从模型的最新版本自动递增。如果不存在任何版本,则版本为 "0.1.0"。
  • variant_description:模型变体的完整描述。
  • repository_url:存储库的 URL。
  • commit_hash:提交哈希。
  • quantization_mode:在转换期间使用的量化模式。必须是 INT8_STANDARD、INT8_ACCURACY_FOCUSED、INT8_INT16_MIXED、INT8_INT16_MIXED_ACCURACY_FOCUSED 或 FP16_STANDARD 之一。INT8_STANDARD 是标准的 INT8 量化,带有校准,可实现最佳性能和模型大小。INT8_ACCURACY_FOCUSED 是带有校准的 INT8 量化,可以提高准确性,而不会降低性能或增加模型大小,具体取决于模型。INT8_INT16_MIXED 在所有层中使用 8 位权重和 16 位激活,以提高数值稳定性和准确性,但会牺牲性能和模型大小。INT8_INT16_MIXED_ACCURACY_FOCUSED 是一种基于校准的混合 INT8 和 INT16 模式,优先考虑准确性而不是吞吐量。FP16_STANDARD 是 FP16 量化,没有校准,适用于需要更高准确性和数值稳定性的模型,但会牺牲性能和模型大小。
  • domain:模型的域。
  • variant_tags:模型变体的标签。
  • variant_id:现有模型版本资源的 ID。如果指定,则使用该版本而不是创建新版本。
  • quantization_data:用于量化此模型的数据。这可以是预定义的域 (DRIVING、FOOD、GENERAL、INDOORS、RANDOM、WAREHOUSE、CLIP、UNKNOWN)、数据集 ID 或本地量化 .zip 文件的路径。传递 .zip 路径本身而不是 CUSTOM;SDK 会自动规范化本地 zip 输入。
  • max_quantization_images:最大量化图像数量。
  • input_shape:模型实例的输入形状。
  • is_deployable:模型实例是否可部署。
  • output_dir:下载文件的目录路径。如果未指定,下载器会在当前工作目录下创建一个以导出实例 slug 命名的目录。
  • tool_version:用于转换的工具版本。对于 RVC2 和 RVC3,这是 IR 版本,而对于 RVC4,这是 SNPE 版本。
  • yolo_input_shape:YOLO 模型的输入形状。
  • yolo_version:YOLO 版本。
  • yolo_class_names:YOLO 模型的类名。
  • **hub_kwargs:传递给 convert 的附加关键字参数。
返回
  • ConvertResponse:转换结果,包含下载的输出路径、导出作业和导出的模型实例。