Explorar el Código

增加了英文版README.md

QingChuanWS hace 5 años
padre
commit
ecb9375845
Se han modificado 3 ficheros con 83 adiciones y 5 borrados
  1. 5 3
      README.md
  2. 77 0
      README_en.md
  3. 1 2
      docs/principle.md

+ 5 - 3
README.md

@@ -1,8 +1,10 @@
-# Tensorflow Lite Micro
+# Tensorflow Lite Micro 软件包
+
+[English Version](./README_en.md)
 
 ## 1、介绍
 
-本软件包是针对RT-Thread内核的Tensorflow Lite嵌入式推理框架Tensorflow Lite Micro软件包. 通过软件包可以实现在嵌入式系统中实现基于Tensorflow Lite框架训练的深度学习模型的端测部署任务.
+本软件包是针对RT-Thread内核的Tensorflow Lite嵌入式推理框架Tensorflow Lite Micro软件包. 通过软件包可以实现在嵌入式系统中实现基于Tensorflow Lite框架训练的深度学习模型的端测部署任务.
 
 ### 1.1 目录结构
 
@@ -57,7 +59,7 @@ RT-Thread online packages
 ( ) No Tensorflow Lite Micro example
 ```
 
-其中audio example是执行官方携带的语音demo, No example则是不集成example文件, 只使用Tensorflow Lite Micro标准框架.(关于menucofing选项的注意事项请参照4. 注意事项部分!)
+其中audio example是执行官方携带的语音demo, No example则是不集成example文件, 只使用Tensorflow Lite Micro标准框架. **关于menucofing选项的注意事项请参照 4. 注意事项部分 **
 
 - Tensorflow Lite Micro整个框架功能较为复杂, API较多, 请先参考[introduction.md](introduction.md), 然后通过[user-guide.md](user-guide.md)来学习基本的部署流程, 在此基础之上再考虑自定义开发的问题.
 

+ 77 - 0
README_en.md

@@ -0,0 +1,77 @@
+# Tensorflow Lite Micro Software Package
+
+## 1. Introduction
+
+This software package is the Tensorflow Lite embedded inference framework Tensorflow Lite Micro software package for the RT-Thread ecosystem . Through this software package, the end deployment task of the deep learning model trained based on the Tensorflow Lite framework can be realized in the embedded system.
+
+### 1.1 Directory structure
+
+| Name | Description |
+| ----------- | :------------------------------------ ------------ |
+| docs | Document directory |
+| examples | Tensorflow Lite Micro offical voice demo |
+| fixedpoint | Fixed-point quantization library required by Tensorflow Lite Micro library |
+| flatbuffers | Model interpretation library flatbuffer required by Tensorflow Lite Micro library |
+| ruy | Matrix acceleration library required by Tensorflow Lite Micro library ruy |
+| tensorflow | Tensorflow Lite Micro library |
+
+### 1.2 License
+
+Tensorflow Lite Micro package complies with the LGPLv2.1 license, please refer to the `LICENSE` file for details.
+
+### 1.3 Dependency
+
+RT-Thread 3.0+
+
+## 2. How to open Tensorflow Lite Micro
+
+To use Tensorflow Lite Micro package, you need to select it in the package manager of RT-Thread. The specific path is as follows:
+
+```
+RT-Thread online packages
+    miscellaneous packages --->
+        [*] Tensorflow Lite Micro: a lightweight deep learning end-test inference framework for RT-Thread operating system.
+```
+
+Then let the RT-Thread package manager automatically update, or use the `pkgs --update` command to update the package to the BSP.
+
+## 3. Use Tensorflow Lite Micro
+
+After successfully downloading the Tensorflow Lite Micro package:
+
+- Change `packages/TensorflowLiteMicro_xxx` (where `xxx` is the package version number) to `packages/TensorflowLiteMicro`
+- Function configuration through menuconfig, the configuration options in menuconfig are:
+
+```
+RT-Thread online packages
+    miscellaneous packages --->
+        [*] Tensorflow Lite Micro: a lightweight deep learning end-test inference framework for RT-Thread operating system.
+            Version(latest) --->
+            Select Offical Example(Enable Tensorflow Lite Micro aduio example) --->
+```
+
+Among them, there are two options in Select Offical Example:
+
+```
+(X) Enable Tensorflow Lite Micro audio example
+( ) No Tensorflow Lite Micro example
+```
+
+Among them, audio example is to implement the official audio demo, No example does not integrate the example file, only uses the Tensorflow Lite Micro standard framework. **For the precautions of the menucofing option, please refer to the 4. Precautions section **
+
+- The whole framework of Tensorflow Lite Micro has more complicated functions and many APIs. Please refer to [introduction.md](introduction.md) first, and then use [user-guide.md](user-guide.md) to learn the basic deployment process, on this basis, consider the issue of custom development.
+
+* The API manual can visit this [link](docs/api.md), which provides the current support for operators
+* More documents are located under [`/docs`](/docs), **Be sure to check** before use
+
+## 4. Matters needing attention
+
+- If the audio example option is selected in the menuconfig, the software package will use the self main function, and the user needs to manually delete all main functions except `packages/TensorflowLiteMicro/example/audio_main.cc`
+- If No example is selected, the system does not have main function, users can design the main function according to their own needs to call the Tensorflow Lite Micro framework
+- This software package occupies 16KB of memory at runtime, and the built-in speech recognition case occupies a total of 22KB of memory at runtime. You need to modify the size of the main function stack and the memory management algorithm through menuconfig!!!
+- This software package currently only runs successfully on the Raspberry Pi 4 platform, other platforms have yet to be tested.
+
+## 5. Contact & Thanks
+
+* Maintenance: QingChuanWS
+* Homepage: https://github.com/QingChuanWS

+ 1 - 2
docs/principle.md

@@ -1,3 +1,2 @@
-# hello 工作原理
+# Tensorflow Lite Micro 工作原理
 
-> 介绍 hello 的工作原理