前言
==============================================================================================

.. include:: _common/0_版权声明.rst

文档概述
--------------------------------------------------------------------------------------------------
本文档主要介绍KA200类脑芯片处理器（简称KA200）的软件栈LynSDK的功能框架、基本概念、典型场景操作流程、API接口说明，以及开发样例等，以便您使用LynSDK提供的API接口，基于KA200硬件功能特性，进行应用开发。

读者对象
--------------------------------------------------------------------------------------------------

本文档主要适用于使用LynSDK的API接口，基于KA200硬件功能特性，进行应用开发的人员。

掌握以下经验和技能，有助于更好地理解本文档：

- 具备C++/C语言程序开发能力；
- 了解机器学习、深度学习、神经网络模型。

.. include:: _common/1_前言_软件.rst

接口命名约定
--------------------------------------------------------------------------------------------------

本文档中各接口命名采用如下规则：

- 规则1：lyn+类别缩写+操作+对象；
- 规则2：操作和对象均采用首字母大写的形式。

类别缩写按字母顺序排列如下所示：

.. list-table:: 
   :header-rows: 1

   * - 类别
     - 缩写
     - 描述
   * - demux
     - demux
     - 表示媒体文件解封装的接口。
   * - image codec
     - icodec
     - 表示图像解码或编码的接口。
   * - inference
     - infer
     - 表示神经网络推理的接口。
   * - image process engine
     - ipe
     - 表示解码后图像预处理的接口。
   * - memory
     - mem
     - 表示内存管理的接口。
   * - video decode
     - vdec
     - 表示视频解码的接口。
   * - video encode
     - venc
     - 表示视频编码的接口。
   * - error
     - err
     - 表示错误处理的接口。


变量命名约定
--------------------------------------------------------------------------------------------------

本文代码示例中涉及的变量，其中，类的私有成员均以 :literal:`“m”+下划线+变量名` 表示，例如 :literal:`m_deviceID` 。

文档结构说明
--------------------------------------------------------------------------------------------------

本文档包含以下章节：

- :ref:`using_constraints`：介绍LynSDK的使用约束。
- :ref:`introduction`：介绍LynSDK的基础知识，包括软件基本功能、基本概念、各概念之间的关系等。
- :ref:`interface_call_process`：介绍常用场景下的各模块接口调用流程。
- :ref:`development_workflow`：介绍使用LynSDK提供的API接口开发用户应用的基本步骤。
- :ref:`prepare_environment`：介绍准备开发环境和运行环境时需要参考的文档。
- :ref:`develop_first_app`：以开发图像分类应用为例，按照开发流程，结合示例代码，介绍各步骤的基本原理。
- :ref:`typical_func`：LynSDK软件栈各功能点的详细介绍。
- LynSDK API参考：介绍各模块API的功能、函数原型以及参数信息等。
- :ref:`lynsdk_sample_usage_guide`：介绍如何使用LynSDK提供的样例。
- :ref:`tools_usage_documentation`：介绍LynSDK提供的小工具，快速实现典型场景的验证和应用。
- :ref:`common_issues`：介绍常见问题的解决方法。
- :doc:`_common/9_fae_support` 提供售前、售后技术支持，以及商务咨询联系方式。