Skip to content
体验新版
项目
组织
正在加载...
登录
切换导航
打开侧边栏
OpenHarmony
Docs
提交
856802a5
D
Docs
项目概览
OpenHarmony
/
Docs
1 年多 前同步成功
通知
159
Star
292
Fork
28
代码
文件
提交
分支
Tags
贡献者
分支图
Diff
Issue
0
列表
看板
标记
里程碑
合并请求
0
Wiki
0
Wiki
分析
仓库
DevOps
项目成员
Pages
D
Docs
项目概览
项目概览
详情
发布
仓库
仓库
文件
提交
分支
标签
贡献者
分支图
比较
Issue
0
Issue
0
列表
看板
标记
里程碑
合并请求
0
合并请求
0
Pages
分析
分析
仓库分析
DevOps
Wiki
0
Wiki
成员
成员
收起侧边栏
关闭侧边栏
动态
分支图
创建新Issue
提交
Issue看板
未验证
提交
856802a5
编写于
7月 29, 2022
作者:
H
HYC
提交者:
Gitee
7月 29, 2022
浏览文件
操作
浏览文件
下载
电子邮件补丁
差异文件
update zh-cn/device-dev/subsystems/subsys-aiframework-devguide-plugin.md.
Signed-off-by:
N
he-yingchuan
<
1639512223@qq.com
>
上级
6289d4b1
变更
1
隐藏空白更改
内联
并排
Showing
1 changed file
with
9 addition
and
9 deletion
+9
-9
zh-cn/device-dev/subsystems/subsys-aiframework-devguide-plugin.md
...vice-dev/subsystems/subsys-aiframework-devguide-plugin.md
+9
-9
未找到文件。
zh-cn/device-dev/subsystems/subsys-aiframework-devguide-plugin.md
浏览文件 @
856802a5
...
...
@@ -13,12 +13,12 @@ AI引擎框架规定了一套算法插件接入规范,各插件需实现规定
| -------- | -------- | -------- |
| const
long
long
GetVersion()
const; |
**作用**
:获取插件版本信息。
<br/>
**返回值**
:版本号(long
long) | - |
| const
char
\*GetInferMode()
const; |
**作用**
:获取算法推理类型。
<br/>
**返回值**
:"SYNC"
or
"ASYNC"; | - |
| int
SyncProcess(IRequest
\*request,
<br/>
IResponse
\*
&
response); |
**作用**
:执行插件同步算法。
<br/>
**返回值**
:0为成功,其他返回值
失败。 |
**request**
(NOT
NULL):用于向算法插件传递请求内容;引擎服务端与插件的数据通道;
<br/>
**response**(NOT
NULL):作为出参用于接收算法插件发回的同步算法执行结果,引擎服务端与插件的数据通道;
|
| int
AsyncProcess(IRequest
\*request,
<br/>
IPluginAlgorithmCallback
\*callback); |
**作用**
:执行异步算法。
<br/>
**返回值**
:0为成功,其他返回值
失败。 |
**request**
(NOT
NULL):用于向算法插件传递请求内容;引擎服务端与插件的数据通道。
<br/>
**callback**(NOT
NULL):算法插件异步执行结果通过此回调返回引擎服务端;
|
| int
Prepare(long
long
transactionId,
<br/>
const
DataInfo
&
inputInfo,
DataInfo
<br/>
&
outputInfo); |
**作用**
:加载算法插件。
<br/>
**返回值**
:0为成功,其他返回值
失败。 |
**transactionId**
(NOT
NULL):事务ID,用于标记客户端+会话信息;
<br/>
**inputInfo**
(可为NULL):加载算法插件传入的一些信息;
<br/>
**outputInfo**
(可为NULL):调用加载接口时的出参,返回相关执行结果;
|
| int
Release(bool
isFullUnload,
long
long
<br/>
transactionId,
const
DataInfo
&
inputInfo); |
**作用**
:卸载相关算法插件。
<br/>
**返回值**
:0为成功,其他返回值
失败。 |
**isFullUnload**
(NOT
NULL):表示此插件是否只剩一个client调用,否则不能直接卸载插件,需等最后一个client来进行卸载;
<br/>
**transactionId**(NOT
NULL):事务ID,用于标记客户端+会话信息;
<br/>
**inputInfo**
(可为NULL):卸载算法插件传入的一些信息;
|
| int
SetOption(int
optionType,
const
<br/>
DataInfo
&
inputInfo); |
**作用**
:设置配置项,可将一些算法的拓展信息通过此接口传入插件。
<br/>
**返回值**
:0为成功,其他返回值
失败。 |
**optionType**
(NOT
NULL):算法配置项,算法插件可根据需要利用此状态位;
<br/>
**inputInfo**
(可为NULL):插件可根据需要通过此入参设置算法参数信息;
|
| int
GetOption(int
optionType,
const
<br/>
DataInfo
&
inputInfo,
DataInfo
<br/>
&
outputInfo); |
**作用**
:给定特定的optionType和inputInfo,获取其对应的配置项信息。
<br/>
**返回值**
:0为成功,其他返回值
失败。 |
**optionType**
(NOT
NULL):所获取配置项信息的对应算法状态位;
<br/>
**inputInfo**
(可为NULL):所获取配置项信息的对应算法参数信息;
<br/>
**outputInfo**
(可为NULL):所要获取的配置项信息返回结果;
|
| int
SyncProcess(IRequest
\*request,
<br/>
IResponse
\*
&
response); |
**作用**
:执行插件同步算法。
<br/>
**返回值**
:0为成功,其他返回值
为失败。 |
**request**
(NOT
NULL):用于向算法插件传递请求内容;引擎服务端与插件的数据通道。
<br/>
**response**(NOT
NULL):作为出参用于接收算法插件发回的同步算法执行结果,引擎服务端与插件的数据通道。
|
| int
AsyncProcess(IRequest
\*request,
<br/>
IPluginAlgorithmCallback
\*callback); |
**作用**
:执行异步算法。
<br/>
**返回值**
:0为成功,其他返回值
为失败。 |
**request**
(NOT
NULL):用于向算法插件传递请求内容;引擎服务端与插件的数据通道。
<br/>
**callback**(NOT
NULL):算法插件异步执行结果通过此回调返回引擎服务端。
|
| int
Prepare(long
long
transactionId,
<br/>
const
DataInfo
&
inputInfo,
DataInfo
<br/>
&
outputInfo); |
**作用**
:加载算法插件。
<br/>
**返回值**
:0为成功,其他返回值
为失败。 |
**transactionId**
(NOT
NULL):事务ID,用于标记客户端+会话信息。
<br/>
**inputInfo**
(可为NULL):加载算法插件传入的一些信息。
<br/>
**outputInfo**
(可为NULL):调用加载接口时的出参,返回相关执行结果。
|
| int
Release(bool
isFullUnload,
long
long
<br/>
transactionId,
const
DataInfo
&
inputInfo); |
**作用**
:卸载相关算法插件。
<br/>
**返回值**
:0为成功,其他返回值
为失败。 |
**isFullUnload**
(NOT
NULL):表示此插件是否只剩一个client调用,否则不能直接卸载插件,需等最后一个client来进行卸载。
<br/>
**transactionId**(NOT
NULL):事务ID,用于标记客户端+会话信息。
<br/>
**inputInfo**
(可为NULL):卸载算法插件传入的一些信息。
|
| int
SetOption(int
optionType,
const
<br/>
DataInfo
&
inputInfo); |
**作用**
:设置配置项,可将一些算法的拓展信息通过此接口传入插件。
<br/>
**返回值**
:0为成功,其他返回值
为失败。 |
**optionType**
(NOT
NULL):算法配置项,算法插件可根据需要利用此状态位。
<br/>
**inputInfo**
(可为NULL):插件可根据需要通过此入参设置算法参数信息。
|
| int
GetOption(int
optionType,
const
<br/>
DataInfo
&
inputInfo,
DataInfo
<br/>
&
outputInfo); |
**作用**
:给定特定的optionType和inputInfo,获取其对应的配置项信息。
<br/>
**返回值**
:0为成功,其他返回值
为失败。 |
**optionType**
(NOT
NULL):所获取配置项信息的对应算法状态位。
<br/>
**inputInfo**
(可为NULL):所获取配置项信息的对应算法参数信息。
<br/>
**outputInfo**
(可为NULL):所要获取的配置项信息返回结果。
|
算法插件类接口:Prepare、SyncProcess、AsyncProcess、Release、SetOption、GetOption分别于客户端接口AieClientPrepare、AieClientSyncProcess、AieClientAsyncProcess、AieClientRelease、AieClientSetOption、AieClientGetOption一一对应;GetInferMode接口用于返回算法执行类型——同步或异步。
...
...
@@ -31,10 +31,10 @@ AI引擎框架规定了一套算法插件接入规范,各插件需实现规定
| 接口名 | 接口说明 | 参数要求 |
| -------- | -------- | -------- |
| void
OnEvent(PluginEvent
event,
<br/>
IResponse
\*response); | 作用:插件通过此回调返回异步算法执行结果。 |
**event**
:算法执行结果枚举,‘ON_PLUGIN_SUCCEED’或
‘ON_PLUGIN_FAIL’(成功或者失败)
;
<br/>
**response**
:算法执行结果封装;
|
| void
OnEvent(PluginEvent
event,
<br/>
IResponse
\*response); | 作用:插件通过此回调返回异步算法执行结果。 |
**event**
:算法执行结果枚举,‘ON_PLUGIN_SUCCEED’或
‘ON_PLUGIN_FAIL’(成功或者失败)
。
<br/>
**response**
:算法执行结果封装。
|
Request、Response是
ai
引擎服务端与算法插件进行通信的对象。Request封装了调用方的请求、输入数据等,而插件主要通过Response将运算之后的结果返回给AI引擎服务端。
Request、Response是
AI
引擎服务端与算法插件进行通信的对象。Request封装了调用方的请求、输入数据等,而插件主要通过Response将运算之后的结果返回给AI引擎服务端。
Request类的属性如下表所示。
...
...
@@ -46,7 +46,7 @@ Request类的属性如下表所示。
| -------- | -------- | -------- |
| innerSequenceId_ | 类型:long
long
<br/>
作用:暂未启用。 | 0 |
| requestId_ | 类型:int
<br/>
作用:标识请求序列,用于绑定返回运算结果。 | 0 |
| operationId_ | 类型:int
<br/>
作用:
目前
暂未启用。 | 0 |
| operationId_ | 类型:int
<br/>
作用:暂未启用。 | 0 |
| transactionId_ | 类型:long
long
<br/>
作用:事务ID,唯一标识clientId+sessionId。 | 0 |
| algoPluginType_ | 类型:int
<br/>
作用:引擎框架根据插件加载顺序分配的算法类型的ID。 | 0 |
| msg_ | 类型:DataInfo
<br/>
作用:存放调用算法接口的输入数据。 | .data
=
nullptr
<br/>
.length
=
0 |
...
...
编辑
预览
Markdown
is supported
0%
请重试
或
添加新附件
.
添加附件
取消
You are about to add
0
people
to the discussion. Proceed with caution.
先完成此消息的编辑!
取消
想要评论请
注册
或
登录