跳到主要内容

函数：finalize

废弃接口/返回码列表​

接口​

返回码​

父主题： pyACL API参考

函数：init​

C函数原型aclError aclInit(const char *configPath)
Python函数ret = acl.init(config_path)
函数功能pyACL初始化函数，同步接口。
输入说明config_path：str，配置文件所在的路径，包含文件名。 配置文件内容为JSON格式（JSON文件内的“{”的层级最多为10，“[”的层级最多为10）。如果以下的默认配置已满足需求，无需修改，可直接调用acl.init接口不传入参数或者可将配置文件配置为空JSON串（即配置文件中只有{}）。 配置文件格式为JSON格式，当前支持以下配置：
- Dump信息配置，包括3种配置：模型Dump配置、单算子Dump配置、溢出算子Dump配置。
- 模型Dump配置（用于导出模型中每一层算子输入和输出数据）、单算子Dump配置（用于导出单个算子的输入和输出数据），导出的数据用于与指定模型或算子进行比对，定位精度问题，配置示例、说明及约束请参见《精度比对工具使用指南》。默认不启用该dump配置。
- 溢出算子Dump配置（用于导出模型中溢出算子的输入和输出数据），导出的数据用于分析溢出原因，定位模型精度的问题，配置示例、说明及约束请参见配置文件示例（溢出算子Dump配置）。默认不启用该dump配置。预留功能，暂不支持。
- Profiling采集信息配置，示例、配置说明及约束请参见《性能分析工具使用指南》。默认不启用Profiling采集信息配置。
- 算子缓存信息老化配置，为节约内存和平衡调用性能，可通过“max_opqueue_num”参数配置“算子类型 - 单算子模型”映射队列的最大长度，如果长度达到最大，则会先删除长期未使用的映射信息以及缓存中的单算子模型，再加载最新的映射信息以及对应的单算子模型。如果不配置映射队列的最大长度，则默认最大长度为“20000”。示例及约束说明请参见配置文件示例（算子缓存信息老化配置）。
建议不要同时配置dump信息和Profiling采集信息，否则dump操作会影响系统性能，导致Profiling采集的性能数据指标不准确。
返回值说明ret：int，错误码。
- 返回0表示成功。
- 返回其它值表示失败。
约束说明- 一个进程内只能调用一次acl.init接口。
- 使用pyACL接口开发应用时，必须先调用acl.init接口，否则可能会导致后续系统内部资源初始化出错，进而导致其它业务异常。
相关接口pyACL还提供了其它使能Dump或Profiling的接口，如下，与acl.init不同的是，以下这些接口相对灵活，可以在一个进程内调用多次接口，每次调用接口时可以基于不同的Dump配置或Profiling配置。
- 获取Dump数据，参见acl.mdl.init_dump、acl.mdl.set_dump、acl.mdl.finalize_dump。
- 获取Profiling数据，参见Profiling数据采集。
参考资源接口调用示例，参见pyACL初始化与去初始化。

配置文件示例（溢出算子Dump配置）​

溢出算子Dump配置的相关约束说明如下：

  • 将“dump_debug”配置为“on”表示开启溢出算子配置，不配置“dump_debug”或将“dump_debug”配置为“off”表示不开启溢出算子配置。

  • 若开启溢出算子配置，则“dump_path”必须配置，表示导出数据文件的存储路径。

    支持配置绝对路径或相对路径：

    • 绝对路径配置以“/”开头，例如：/home。
    • 相对路径配置直接以目录名开始，例如：output。

    获取导出的数据文件后，如何解析请参见溢出算子数据采集及分析。

  • 溢出算子Dump配置，不能与模型Dump配置或单算子Dump配置同时开启，否则会返回报错。

配置文件中的示例内容如下：

{
    "dump":{
        "dump_path":"output",
        "dump_debug":"on"
    }
}

配置文件示例（算子缓存信息老化配置）​

算子缓存信息老化配置的相关约束说明如下：

  • 对于静态加载的算子，调用acl.op.set_model_dir接口加载指定目录下的单算子模型或调用acl.op.load接口加载指定单算子模型时，老化配置无效，不会对该部分的算子信息做老化。
  • pyACL内部分开维护固定Shape和动态Shape算子的映射队列，最大长度都为“max_opqueue_num”参数值。
  • “max_opqueue_num”参数值为静态加载算子的单算子模型个数和在线编译算子的单算子模型个数的总和，因此“max_opqueue_num”参数值应大于当前进程中可用的、静态加载算子的单算子模型个数，否则会导致在线编译算子的信息无法老化。

配置文件中的示例内容如下：

{
        "max_opqueue_num": "10000"
}

父主题： 系统配置

函数：finalize​

C函数原型aclError aclFinalize()
Python函数ret = acl.finalize()
函数功能pyACL去初始化函数，用于释放进程内的pyACL相关资源，同步接口。
输入说明无
返回值说明ret：int，错误码。
- 返回0表示成功。
- 返回其它值表示失败。
约束说明应用的进程退出前，应显式调用该接口实现pyACL去初始化，否则可能会导致异常，例如应用进程退出时有异常报错。 不建议在析构函数中调用acl.finalize接口，否则在进程退出时可能由于单例析构顺序未知而导致进程异常退出的问题。
参考资源接口调用示例，参见pyACL初始化与去初始化。

父主题： 系统配置

函数：get_version​

C函数原型aclErroraclrtGetVersion(int32_t *majorVersion, int32_t *minorVersion, int32_t *patchVersion)
Python函数major_version, minor_version, patch_version, ret = acl.get_version()
函数功能查询接口版本号，pyACL接口版本号命名可以采用：A.B.C模式，其中C表示bug修复，B表示新增接口，A表示有不兼容修改。同步接口。
输入说明无。
返回值说明major_version：int，从1开始，如果出现接口的不兼容变更时，加1。 minor_version：int，从0开始，按照迭代周期，有新增接口时加1。 patch_version：int，从0开始，表示本版本仅仅解决了问题，在“majorVersion”、“minorVersion”不变的情况下加1。但“majorVersion”、“minorVersion”增加的时候，“patchVersion”一般为“0”。 ret：int，错误码。
- 返回0表示成功。
- 返回其它值表示失败。
约束说明无

父主题： 系统配置

函数：get_soc_name​

C函数原型const char *aclrtGetSocName()
Python函数name = acl.get_soc_name()
函数功能查询当前运行环境的芯片版本，同步接口。
输入说明无
返回值说明name：str，返回芯片版本字符串。如果通过该接口获取芯片版本失败，则返回None。
约束说明无

父主题： 系统配置

函数：get_recent_err_msg​

C函数原型const char *aclGetRecentErrMsg()
Python函数msg = acl.get_recent_err_msg()
函数功能获取并清空与本接口在同一个线程中的其它pyACL接口调用失败时的错误描述信息。同步接口。
输入说明无
返回值说明msg：str，返回错误描述字符串。 如果通过本接口获取到多条错误描述信息，最上面的错误描述信息为最新的。 获取错误描述信息失败时，返回None。
约束说明- 建议在每次调用pyACL接口失败时都调用acl.get_recent_err_msg接口，以便获取调用pyACL接口异常时的错误描述信息，用于定位问题。
- 同一个线程中多次调用acl.get_recent_err_msg接口后，只有最后一次调用acl.get_recent_err_msg接口返回的错误描述字符串有效，之前acl.get_recent_err_msg接口返回的错误描述字符串不能使用，否则可能导致内存非法访问。
- 如果未在每次调用pyACL接口失败时调用acl.get_recent_err_msg接口，则可能导致错误信息堆积、丢失。

父主题： 系统配置

在线提单