前言
声明
版权所有 ©北京灵汐科技有限公司 2021。保留一切权利。
非经北京灵汐科技有限公司(以下简称“本公司”)书面许可,任何单位和个人不得擅自摘抄、复制、修改、摄制、翻译、汇编本文档内容的任何部分或全部,并不得以任何形式传播。
商标声明
服务声明
您购买的产品、服务或特性等应受本公司商业合同和条款的约束,本文档中描述的全部或任何部分的产品、服务或特性可能不在您的购买或使用范围之内。除非合同另有约定,本公司对本文档内容不做任何明示或默示的声明或保证。本文档不构成任何明示、暗示的知识产权转让或许可。
更新声明
由于产品版本升级或其他原因,本文档内容可能会不定期进行更新或变更。本公司保留随时对本文档进行更新或变更而不预先通知的权利。除非另有约定,本文档仅作为使用指导,本文档中的所有陈述、信息和建议不构成任何明示或暗示的担保。
安全声明
在使用本产品前,请您认真阅读本文档内警示信息,安全、合理使用本产品,避免造成数据丢失、元器件损坏、火灾、触电或其他伤害。
文档概述
本文档主要介绍KA200类脑芯片处理器(简称KA200)的软件栈LynSDK的功能框架、基本概念、典型场景操作流程、API接口说明,以及开发样例等,以便您使用LynSDK提供的API接口,基于KA200硬件功能特性,进行应用开发。
读者对象
本文档主要适用于使用LynSDK的API接口,基于KA200硬件功能特性,进行应用开发的人员。
掌握以下经验和技能,有助于更好地理解本文档:
具备C++/C语言程序开发能力;
了解机器学习、深度学习、神经网络模型。
符号约定
在本文中可能出现下列标志,它们所代表的含义如下。
符号 |
说明 |
---|---|
表示有高度潜在危险,如不能避免,可能导致人员死亡或严重伤害。 |
|
表示有中度潜在危险,如不能避免,可能导致人员轻微或中等伤害。 |
|
表示有潜在危险,如不能避免,可能导致设备或器件损坏、数据丢失、设备性能降低或不可预知的结果。 |
|
表示正文的附加信息,是对正文的强调和补充。 |
表格内容约定
内容 |
说明 |
---|---|
- |
表示无内容单元格。 |
* |
表示用户可根据需要进行配置。 |
版本号约定
配套软件文档版本号说明:VA.B.C.D
其中,
A.B.C与软件版本保持一致;
D表示当前软件版本下,文档的修改次数。从0开始计数,每修改一次,数字加1。
接口命名约定
本文档中各接口命名采用如下规则:
规则1:lyn+类别缩写+操作+对象;
规则2:操作和对象均采用首字母大写的形式。
类别缩写按字母顺序排列如下所示:
类别 |
缩写 |
描述 |
---|---|---|
demux |
demux |
表示媒体文件解封装的接口。 |
image codec |
icodec |
表示图像解码或编码的接口。 |
inference |
infer |
表示神经网络推理的接口。 |
image process engine |
ipe |
表示解码后图像预处理的接口。 |
memory |
mem |
表示内存管理的接口。 |
video decode |
vdec |
表示视频解码的接口。 |
video encode |
venc |
表示视频编码的接口。 |
error |
err |
表示错误处理的接口。 |
变量命名约定
本文代码示例中涉及的变量,其中,类的私有成员均以 “m”+下划线+变量名
表示,例如 m_deviceID
。
文档结构说明
本文档包含以下章节:
使用约束:介绍LynSDK的使用约束。
简介:介绍LynSDK的基础知识,包括软件基本功能、基本概念、各概念之间的关系等。
接口调用流程介绍:介绍常用场景下的各模块接口调用流程。
开发流程:介绍使用LynSDK提供的API接口开发用户应用的基本步骤。
准备开发和运行环境:介绍准备开发环境和运行环境时需要参考的文档。
开发首个应用:以开发图像分类应用为例,按照开发流程,结合示例代码,介绍各步骤的基本原理。
开发典型功能点的介绍:LynSDK软件栈各功能点的详细介绍。
LynSDK API参考:介绍各模块API的功能、函数原型以及参数信息等。
LynSDK样例使用指导:介绍如何使用LynSDK提供的样例。
工具使用说明:介绍LynSDK提供的小工具,快速实现典型场景的验证和应用。
常见问题:介绍常见问题的解决方法。
技术支持 提供售前、售后技术支持,以及商务咨询联系方式。