基础接口

所有参数组的基础接口。

模块:polygraphy.tools.args

class ArgGroups(dct=None)[source]

基类:Interface

将参数组类型映射到参数组。

class BaseArgs[source]

基类:object

向命令行解析器添加参数,并提供基于参数创建 Polygraphy 对象的功能。

添加选项的子类必须定义一个文档字符串,其中包括参数组的节标题、一个简短的描述(应完成句子:“与...相关的选项”),以及最终的任何依赖项

Section Header: Description

Depends on:

    - OtherArgs0
    - OtherArgs1: <additional info: condition under which it is needed, or reason for dependency>

<Optional Additional Documentation>

例如

TensorRT Engine: loading TensorRT engines.

Depends on:

    - ModelArgs
    - TrtLoadPluginsArgs
    - TrtLoadNetworkArgs: if building engines
    - TrtConfigArgs: if building engines
    - TrtSaveEngineBytesArgs: if allow_saving == True

节标题和描述将用于填充工具的帮助输出。

group

与此参数组关联的 argparse 参数组

arg_groups

将参数组类型映射到参数组

类型:

ArgGroups

allows_abbreviation()[source]

是否允许缩写选项。启用此功能后,可以使用选项的前缀来代替指定整个选项。例如,--iterations 可以仅用 --iter 指定。这会破坏 argparse.REMAINDER,因此使用该参数组的任何参数组都应禁用此功能。默认实现返回 True。

返回值:

bool

register(arg_groups)[source]

向此参数组注册所有可用参数组的字典。

参数:

arg_groups (ArgGroups) – 将参数组类型映射到参数组。

add_parser_args(parser)[source]

向命令行解析器添加参数。

保证此方法仅在 register 之后调用。

参数:

parser (argparse.ArgumentParser) – 参数解析器。

parse(args)[source]

从命令行参数解析相关参数,并填充此参数组的相应属性。

保证此方法仅在 add_parser_args 之后调用。

参数:

args – argparse 提供的参数。

add_to_script(script, *args, **kwargs) str[source]

向给定脚本添加代码,以执行此参数组提供的功能。

例如,TrtConfigArgs 将添加对 CreateConfig 的调用。

保证此方法仅在 parse 之后调用。

参数:

script (polygraphy.tools.script.Script) – 应向其添加代码的脚本。

返回值:

脚本中修改或添加的变量的名称。

返回类型:

str

class BaseRunnerArgs[source]

基类:BaseArgs

类似于 BaseArgs,但专门用于处理运行器的参数组。

add_to_script(script) str[source]
返回值:

脚本中运行器列表的名称。

返回类型:

str

get_name_opt() Tuple[str, str][source]

返回一个元组,其中包含运行器的可读名称和命令行选项的名称(不带 前导破折号),该选项应用于选择由此参数组控制的运行器。

例如:("TensorRT", "trt")

get_extra_help_text() str[source]

返回要在此运行器的工具帮助输出中显示的任何额外帮助文本。