diff --git a/zh-cn/device-dev/subsystems/subsys-ai-aiframework-devguide.md b/zh-cn/device-dev/subsystems/subsys-ai-aiframework-devguide.md index 518a4ca6c88afc76912954f812386f64ee6ece5d..549708ca294b7694f2743dfa36aa0e11d62015bc 100644 --- a/zh-cn/device-dev/subsystems/subsys-ai-aiframework-devguide.md +++ b/zh-cn/device-dev/subsystems/subsys-ai-aiframework-devguide.md @@ -22,7 +22,7 @@ AI引擎框架结构如下图所示。 ### 代码管理规范 -AI引擎框架包含client、server和common三个主要模块，其中client提供server端连接管理功能，北向SDK在算法对外接口中需封装调用client提供的公共接口；server提供插件加载以及任务管理等功能，各Plugin实现由server提供的插件接口，完成插件接入；common提供与平台相关的操作方法、引擎协议以及相关工具类，供其他各模块调用。 +AI引擎框架包含client、server和common三个主要模块，其中client提供server端连接管理功能，OpenHarmony SDK在算法对外接口中需封装调用client提供的公共接口；server提供插件加载以及任务管理等功能，各Plugin实现由server提供的插件接口，完成插件接入；common提供与平台相关的操作方法、引擎协议以及相关工具类，供其他各模块调用。 AI引擎框架各模块之间的代码依赖关系如下图所示： @@ -33,9 +33,9 @@ AI引擎框架各模块之间的代码依赖关系如下图所示： ![zh-cn_image_0000001151931738](figures/zh-cn_image_0000001151931738.jpg) -#### 建议：插件与北向SDK在AI引擎指定的路径下进行代码开发 +#### 建议：插件与OpenHarmony SDK在AI引擎指定的路径下进行代码开发 -在AI引擎框架的整体规划中，北向SDK属于client端的一部分，插件由server端调用，属于server端的一部分，因此AI引擎框架为接入的插件与北向SDK规划的路径： +在AI引擎框架的整体规划中，OpenHarmony SDK属于client端的一部分，插件由server端调用，属于server端的一部分，因此AI引擎框架为接入的插件与OpenHarmony SDK规划的路径： - SDK代码路径：//foundation/ai/engine/services/client/algorithm_sdk @@ -52,7 +52,7 @@ AI引擎框架各模块之间的代码依赖关系如下图所示： #### 规则：插件提供的全部对外接口，统一存放在AI业务子系统interfaces/kits目录 -北向SDK对外接口是AI业务子系统提供能力的对外暴露方式，按照OpenHarmony的接口管理要求，需统一存放在各子系统的interfaces/kits目录中。当前AI业务子系统插件对外接口路径为//foundation/ai/engine/interfaces/kits，不同插件可在该路径下添加目录，比如增加cv插件，则在路径//foundation/ai/engine/interfaces/kits/cv下面存放接口文件。 +OpenHarmony SDK对外接口是AI业务子系统提供能力的对外暴露方式，按照OpenHarmony的接口管理要求，需统一存放在各子系统的interfaces/kits目录中。当前AI业务子系统插件对外接口路径为//foundation/ai/engine/interfaces/kits，不同插件可在该路径下添加目录，比如增加cv插件，则在路径//foundation/ai/engine/interfaces/kits/cv下面存放接口文件。 #### 规则：插件编译输出路径必须是在/usr/lib @@ -78,7 +78,7 @@ server端加载插件是采用dlopen方式，只支持在/usr/lib路径进行， #### 规则：SDK需按算法调用顺序，封装client对外提供接口；对于异步插件对应的SDK，需要实现client提供的回调接口IClientCb -AI引擎的client端对外提供的接口包括AieClientInit、AieClientPrepare、AieClientSyncProcess、AieClientAsyncProcess、AieClientRelease、AieClientDestroy、AieClientSetOption、AieClientGetOption，SDK需要根据插件的北向接口按照顺序至少封装AieClientInit、AieClientPrepare、AieClientSyncProcess/AieClientAsyncProcess、AieClientRelease、AieClientDestroy五个接口，否则会出现调用问题或者内存泄漏。比如封装过程遗漏了AieClientPrepare接口，则server端无法完成插件加载，故后面的接口都无法调用成功。 +AI引擎的client端对外提供的接口包括AieClientInit、AieClientPrepare、AieClientSyncProcess、AieClientAsyncProcess、AieClientRelease、AieClientDestroy、AieClientSetOption、AieClientGetOption，SDK需要根据插件的接口按照顺序至少封装AieClientInit、AieClientPrepare、AieClientSyncProcess/AieClientAsyncProcess、AieClientRelease、AieClientDestroy五个接口，否则会出现调用问题或者内存泄漏。比如封装过程遗漏了AieClientPrepare接口，则server端无法完成插件加载，故后面的接口都无法调用成功。 对于异步插件，SDK需要实现IClientCb接口，用于接收来自client端的算法推理结果，并将该结果返回给三方调用者。