Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add KL730 related documents in PLUS docs #38

Merged
merged 1 commit into from
Mar 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 39 additions & 38 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,52 +7,55 @@ It is composed of tools, control libraries and example references.

![](./imgs/kneronAI_arch.png)

Kneron AI consists the following components:
Kneron AI consists the following components:

1. **Kneron AI Development Kit - Kneron PLUS**
It is Platform Libraries Unified Software to control Kneron Chip via USB interface
*KL520 SDK v1.6.0 / KL720 SDK v1.4.1 / KL630 SDK v2.5.2, or higher version is required*
1. **Kneron AI Development Kit - Kneron PLUS**
It is Platform Libraries Unified Software to control Kneron Chip via USB interface
*KL520 SDK v1.6.0 / KL720 SDK v1.4.1 / KL630 SDK v2.5.2 / KL730 SDK v1.0.0-alpha, or higher version is required*

2. **Kneron AI Development Kit - Firmware SDK**
Open source for peripheral drivers, middleware and application code can be optimized to meet the needs for different applications
- KL520 SDK
- KL720 SDK
2. **Kneron AI Development Kit - Firmware SDK**
Open source for peripheral drivers, middleware and application code can be optimized to meet the needs for different applications
- KL520 SDK
- KL720 SDK
- KL630 SDK

3. **Kneron AI Development Kit - Kneron Model Toolchain**
A series of utilities for Kneron AI model creation
- ONNX converter
- Compiler
- Quantizer
- Evaluator
- Simulator

4. **Kneron AI Model Zoo**
A set of structure pre-optimized models used for demo and also open for re-training

5. **Kneron AI Chips**
- KL520: Dongle, 96board, M.2 board
- KL720: Dongle, 96board
- KL730 SDK

3. **Kneron AI Development Kit - Kneron Model Toolchain**
A series of utilities for Kneron AI model creation
- ONNX converter
- Compiler
- Quantizer
- Evaluator
- Simulator

4. **Kneron AI Model Zoo**
A set of structure pre-optimized models used for demo and also open for re-training

5. **Kneron AI Chips**
- KL520: Dongle, 96board, M.2 board
- KL720: Dongle, 96board
- KL630: 96board
- KL730: 96board

---
## Compatibility Table

Versions | KL520 SDK version | KL720 SDK version | KL630 SDK version (NNM version)
:------------------|:------------------|:------------------|:-------------------------------
Kneron PLUS v2.2.x | 2.2.x | 2.2.x | 2.5.5 (1.2.x)
Kneron PLUS v2.1.x | 2.1.x | 2.1.x | 2.5.2 (1.0.x)
Kneron PLUS v2.0.x | 2.0.x | 2.0.x | Not supported
Kneron PLUS v1.3.x | 1.7.x | 1.5.x | Not supported
Kneron PLUS v1.2.x | 1.6.x | 1.4.x | Not supported
host_lib v1.0.0 | 1.5.0.0 | 1.3.0 | Not supported
host_lib v0.9.x | 1.4.0.x | Not supported | Not supported

**Notes:**
Versions | KL520 SDK version | KL720 SDK version | KL630 SDK version (NNM version) | KL730 SDK version
:------------------------|:------------------|:------------------|:------------------------------- | :----------------
Kneron PLUS v2.3.x-alpha | 2.2.x | 2.2.x | 2.5.5 (1.2.x) | 1.0.0-alpha
Kneron PLUS v2.2.x | 2.2.x | 2.2.x | 2.5.5 (1.2.x) | Not supported
Kneron PLUS v2.1.x | 2.1.x | 2.1.x | 2.5.2 (1.0.x) | Not supported
Kneron PLUS v2.0.x | 2.0.x | 2.0.x | Not supported | Not supported
Kneron PLUS v1.3.x | 1.7.x | 1.5.x | Not supported | Not supported
Kneron PLUS v1.2.x | 1.6.x | 1.4.x | Not supported | Not supported
host_lib v1.0.0 | 1.5.0.0 | 1.3.0 | Not supported | Not supported
host_lib v0.9.x | 1.4.0.x | Not supported | Not supported | Not supported

**Notes:**
**Host API v1.0.0(host_lib)** *stays with [KL520 SDK v1.5.0.0](./520_1.5.0.0/getting_start.md) / [KL720 SDK v1.3.0](./720_1.3.0/getting_start_720.md) and deprecated from KL520 SDK v1.6.0/KL720 SDK v1.4.1*

---
## First Touch
## First Touch

**Kneron PLUS** provides low barrier AI inference experience to touch AI.

Expand All @@ -61,11 +64,9 @@ Please see [Kneron PLUS-C - Getting Started](./plus_c/getting_started.md) \(or [
---
## References

- [Kneron PLUS-C](./plus_c/introduction/introduction.md) / [Kneron PLUS-Python](./plus_python/introduction/index.md)
- [Kneron PLUS-C](./plus_c/introduction/introduction.md) / [Kneron PLUS-Python](./plus_python/introduction/index.md)
- [Firmware KL520 SDK](./520_2.2.0/introduction.md)
- [Firmware KL720 SDK](./720_2.2.0/introduction.md)
- [Kneron Model Toolchain](./toolchain/manual_1_overview.md)
- [Model Zoo - C-examples](./plus_c/modelzoo/index.md) / [Python-examples](./plus_python/modelzoo/index.md)
- [Model Zoo - retraining](./model_training/classification.md)


4 changes: 3 additions & 1 deletion docs/plus_c/appendix/npu_raw_output_memory_layout.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,5 +10,7 @@ In **KL630**, the data values are in (channel, height, width_align) format, wher

In **KL720**, the data values are in (channel, height, width_align) format, where width_align is the width aligned to the nearest 16 bytes (NPU data layout format: 16W1C8B).

- For example, assume the output node shape is 1x4x12x12 (BxCxHxW). The NPU raw output node data will be arranged as:
In **KL730**, the data values are in (channel, height, width_align) format, where width_align is the width aligned to the nearest 16 bytes (NPU data layout format: 16W1C8B).

- For example, assume the output node shape is 1x4x12x12 (BxCxHxW). The NPU raw output node data will be arranged as:
![](../imgs/customized_api_post_proc_mem_layout.png)
2 changes: 1 addition & 1 deletion docs/plus_c/appendix/supported_npu_data_layout_format.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ To infer by Kneron NPU, the input/output data must be re-layout by the following
| Entry #1 | P31CH0 | P30CH0 | P29CH0 | P28CH0 | P27CH0 | P26CH0 | P25CH0 | P24CH0 | P23CH0 | P22CH0 | P21CH0 | P20CH0 | P19CH0 | P18CH0 | P17CH0 | P16CH0 |
| Entry #2 | P47CH0 | P46CH0 | P45CH0 | P44CH0 | P43CH0 | P42CH0 | P41CH0 | P40CH0 | P39CH0 | P38CH0 | P37CH0 | P36CH0 | P35CH0 | P34CH0 | P33CH0 | P32CH0 |

2. **KL720**
2. **KL630, KL720 and KL630**

- Input Data Layout
- **4W4C8B** - 4 Column 4 Channel 8-Bit Feature Map Format
Expand Down
Loading
Loading