Feature/update docs (#1176)

* update faq * update Homepage * update link * update gif link * update gif link * update FAQ * update FAQ
kendryte · Mar 13, 2024 · a13d43d · a13d43d
1 parent dbcde6f
commit a13d43d
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -21,8 +21,8 @@ Technical Discussion QQ Group: 790699378 .   Answer: 人工智能
 - [FAQ](./docs/FAQ_EN.md)
 - [Example](./examples/user_guide/k230_simulate-EN.ipynb)
 - [Colab run](https://colab.research.google.com/drive/1m8TTree096m5VHmq-Uc60gXyltVCgnRb?usp=sharing)
-- [ *Version relationship between `nncase` and `K230_SDK`* ](https://developer.canaan-creative.com/k230/dev/zh/03_other/K230_SDK_%E7%89%88%E6%9C%AC%E8%AF%B4%E6%98%8E.html#ai-sdkcanmvnncase)
-
+- [ *Version relationship between `nncase` and `K230_SDK`* ](https://developer.canaan-creative.com/k230/dev/zh/03_other/K230_SDK_nncase%E7%89%88%E6%9C%AC%E5%AF%B9%E5%BA%94%E5%85%B3%E7%B3%BB.html#k230sdknncase)
+- [update nncase runtime library in SDK](https://developer.canaan-creative.com/k230/dev/zh/03_other/K230_SDK%E6%9B%B4%E6%96%B0nncase%E8%BF%90%E8%A1%8C%E6%97%B6%E5%BA%93%E6%8C%87%E5%8D%97.html)
 
 ### Install
 
@@ -42,6 +42,7 @@ Technical Discussion QQ Group: 790699378 .   Answer: 人工智能
 
 All version of `nncase` and `nncase-kpu` in [Release](https://github.com/kendryte/nncase/releases).
 
+
 ### Supported operators
 
 - [TFLite ops](./docs/tflite_ops.md)
@@ -140,16 +141,19 @@ make && make install
 
 ## Resources
 
-### Kendryte developer community
+### Canaan developer community
+
+[Canaan developer community](https://developer.canaan-creative.com/resource) contains all resources related to K210, K510, and K230.
 
-[Kendryte developer community](https://developer.canaan-creative.com/resource) contains all resources related to K210, K510, and K230.
 - 资料下载 --> Pre-compiled images available for the development boards corresponding to the three chips.
 - 文档 --> Documents corresponding to the three chips.
 - 模型库 --> Examples and code for industrial, security, educational and other scenarios that can be run on the K210 and K230.
 - 模型训练 --> The model training platform for K210 and K230 supports the training of various scenarios.
 
 ### Bilibili
-- [Kendryte AI tutorial and application demonstration](https://space.bilibili.com/677429436)
+
+- [Canaan AI tutorial and application demonstration](https://space.bilibili.com/677429436)
+
 
 ### K210 related repo
 

diff --git a/docs/FAQ_EN.md b/docs/FAQ_EN.md
@@ -29,6 +29,7 @@ A: Use `sudo gedit /proc/sys/fs/inotify/max_user_instances` to change 128 to a l
 ### 2.3 `RuntimeError: Failed to initialize hostfxr`
 
 A：Need to install dotnet-sdk-7.0.
+
 - Linux:
 
     ```shell
@@ -60,6 +61,7 @@ A: Need to install `nncase-kpu`.
 ### 3.1 When inferring, the error `nncase.simulator.k230.sc: not found` occurs.
 
 Or these situations:
+
 - `"nncase.simulator.k230.sc: Permision denied."`
 - `"Input/output error."`
 
@@ -87,3 +89,14 @@ A: Usually it is caused by memory allocation failure, you can do the following t
 
 - Check whether the generated `kmodel` exceeds the currently available system memory.
 - Check App for memory leaks.
+
+### 4.3 throw error when load model
+
+The exception `terminate: Invalid kmodel` is thrown when attempting to load a `kmodel` as bellow.
+
+```CPP
+interp.load_model(ifs).expect("Invalid kmodel");
+```
+
+A：The issue arises due to a mismatch between the nncase version used when compiling the kmodel and the current SDK version. Please refer to the [SDK-nncase Version Correspondence](https://developer.canaan-creative.com/k230/dev/zh/03_other/K230_SDK_nncase%E7%89%88%E6%9C%AC%E5%AF%B9%E5%BA%94%E5%85%B3%E7%B3%BB.html) for a lookup, and follow the [Update the nncase Runtime Library Guide](https://developer.canaan-creative.com/k230/dev/zh/03_other/K230_SDK%E6%9B%B4%E6%96%B0nncase%E8%BF%90%E8%A1%8C%E6%97%B6%E5%BA%93%E6%8C%87%E5%8D%97.html) to resolve the problem.
+
diff --git a/docs/FAQ_ZH.md b/docs/FAQ_ZH.md
@@ -85,3 +85,13 @@ A：通常是因为内存分配失败导致的，可做如下排查。
 
 - 检查生成的kmodel是否超过当前系统可用内存
 - 检查App是否存在内存泄露
+
+### 4.3 加载模型时抛出异常
+
+加载`kmodel`代码如下时，抛出异常 `terminate:Invalid kmodel`。
+
+```CPP
+interp.load_model(ifs).expect("Invalid kmodel");
+```
+
+A：是由于编译`kmodel`时的nncase版本与当前SDK版本不匹配导致，请按照[SDK、nncase版本对应关系](https://developer.canaan-creative.com/k230/dev/zh/03_other/K230_SDK_nncase%E7%89%88%E6%9C%AC%E5%AF%B9%E5%BA%94%E5%85%B3%E7%B3%BB.html)查询，并按照[更新nncase运行时库教程](https://developer.canaan-creative.com/k230/dev/zh/03_other/K230_SDK%E6%9B%B4%E6%96%B0nncase%E8%BF%90%E8%A1%8C%E6%97%B6%E5%BA%93%E6%8C%87%E5%8D%97.html)解决。
diff --git a/docs/readme_ZH.md b/docs/readme_ZH.md
@@ -20,7 +20,9 @@ Telegram: [nncase community](https://t.me/joinchat/PPcEPZMLaTViNDI1)
 - [常见问题](./FAQ_ZH.md)
 - [示例](../examples/user_guide/k230_simulate-ZH.ipynb)
 - [Colab 在线示例](https://colab.research.google.com/drive/1m8TTree096m5VHmq-Uc60gXyltVCgnRb?usp=sharing)
-- [ *nncase与K230_SDK版本对应关系说明* ](https://developer.canaan-creative.com/k230/dev/zh/03_other/K230_SDK_%E7%89%88%E6%9C%AC%E8%AF%B4%E6%98%8E.html#ai-sdkcanmvnncase)
+- [ *nncase与K230_SDK版本对应关系说明* ](https://developer.canaan-creative.com/k230/dev/zh/03_other/K230_SDK_nncase%E7%89%88%E6%9C%AC%E5%AF%B9%E5%BA%94%E5%85%B3%E7%B3%BB.html#k230sdknncase)
+- [SDK中更新nncase运行时库](https://developer.canaan-creative.com/k230/dev/zh/03_other/K230_SDK%E6%9B%B4%E6%96%B0nncase%E8%BF%90%E8%A1%8C%E6%97%B6%E5%BA%93%E6%8C%87%E5%8D%97.html)
+
 
 ### 安装