接口列表
本文档主要描述UDF(User Define Function)模块对外提供的接口,用户可以调用这些接口进行自定义处理函数的开发,然后通过DataFlow构图在CPU上执行该处理函数。
您可以在CANN软件安装后文件存储路径下的“python/site-packages/dataflow/flow_func/flow_func.py”查看对应接口的实现。接口列表如下。
FlowMsg类
接口名称 |
简介 |
---|---|
FlowMsg的构造函数。 |
|
获取FlowMsg的消息类型。 |
|
获取FlowMsg中的tensor对象。 |
|
设置FlowMsg消息中的错误码。 |
|
获取输入FlowMsg消息中的错误码。 |
|
设置FlowMsg消息头中的开始时间戳。 |
|
获取FlowMsg消息中的开始时间戳。 |
|
设置FlowMsg消息头中的结束时间戳。 |
|
获取FlowMsg消息中的结束时间戳。 |
|
设置FlowMsg消息头中的flags。 |
|
获取FlowMsg消息头中的flags。 |
|
设置路由的标签。 |
|
获取FlowMsg消息中的事务ID,事务Id从1开始计数,每feed一批数据,事务Id会加一,可用于识别哪一批数据。 |
Tensor类
接口名称 |
简介 |
---|---|
Tensor构造函数和析构函数。 |
|
获取Tensor的Shape。 |
|
获取Tensor中的数据类型。 |
|
获取Tensor中的数据大小。 |
|
获取Tensor中的元素的个数。 |
|
对tensor进行Reshape操作,不改变tensor的内容。 |
MetaParams类
接口名称 |
简介 |
---|---|
PyMetaParams构造函数。 |
|
获取Flowfunc的实例名。 |
|
获取指定名称的int类型属性值。 |
|
获取指定名称的bool数组类型属性值。 |
|
获取指定名称的int数组类型属性值。 |
|
获取指定名称的int二维数组类型属性值。 |
|
获取指定名称的bool类型属性值。 |
|
获取指定名称的float数组类型属性值。 |
|
获取指定名称的numpy dtype类型的属性值。 |
|
获取指定名称的numpy dtype数组类型的属性值。 |
|
获取指定名称的string类型的属性值。 |
|
获取指定名称的string数组类型的属性值。 |
|
获取指定名称的float类型属性值。 |
|
获取Flowfunc的输入个数。 |
|
获取Flowfunc的输出个数。 |
|
获取Flowfunc的工作路径。 |
|
获取正在运行的设备ID。 |
MetaRunContext类
接口名称 |
简介 |
---|---|
MetaRunContext构造函数。 |
|
根据shape、data type以及对齐大小申请tensor类型的FlowMsg。 |
|
设置指定index的output的tensor。 |
|
批量设置指定index的output的tensor。 |
|
同步执行指定的模型。 |
|
申请空数据的MsgType类型的message。 |
|
获取用户定义数据。 |
|
UDF主动上报异常。 |
|
UDF获取其他UDF节点上报的异常。 |
AffinityPolicy类
接口名称 |
简介 |
---|---|
亲和策略枚举定义。 |
BalanceConfig类
接口名称 |
简介 |
---|---|
BalanceConfig构造函数。 |
|
设置输出数据对应权重矩阵中的位置。 |
|
获取内部配置对象,被set_output或者set_multi_outputs调用。 |
UDF日志接口
接口名称 |
简介 |
---|---|
FlowFuncLogger构造函数。 |
|
获取日志扩展头信息。 |
|
查询对应级别和类型的日志是否开启。 |
|
运行日志Error级别日志宏。 |
|
运行日志Info级别日志宏。 |
|
调试日志Error级别日志宏。 |
|
调试日志Warn级别日志宏。 |
|
调试日志Info级别日志宏。 |
|
调试日志Debug级别日志宏。 |