Skip to content

Commit

Permalink
Merge pull request #13 from howardshao0/master
Browse files Browse the repository at this point in the history 
Adjust link and correct feature table in PLUS docs
  • Loading branch information
@MrWhoami
MrWhoami authored Jan 18, 2023
2 parents 9f5d893 + 3a9f4e6 commit 481e437
Show file tree
Hide file tree
Showing 24 changed files with 201 additions and 158 deletions.
15 changes: 8 additions & 7 deletions docs/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,13 +36,14 @@ Kneron AI consists the following components:
---
## Compatibility Table

Versions | KL520 SDK version | KL720 SDK version
:------------------|:------------------|:--------------
Kneron PLUS v2.0.x | 2.0.x | 2.0.x
Kneron PLUS v1.3.x | 1.7.x | 1.5.x
Kneron PLUS v1.2.x | 1.6.x | 1.4.x
host_lib v1.0.0 | 1.5.0.0 | 1.3.0
host_lib v0.9.x | 1.4.0.x | Not supported
Versions | KL520 SDK version | KL720 SDK version | KL630 SDK version (NNM version)
:------------------|:------------------|:------------------|:-------------------------------
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:**
**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*
Expand Down
86 changes: 43 additions & 43 deletions docs/plus_c/appendix/api_support_list.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,52 +4,52 @@ The following mapping table shows the **Kneron PLUS** supported C/Python API:

* **Core API**

| Function Name | C | Python |
| ------------------------------------------------------------------- | --------- | --------- |
| kp\_scan\_devices | Yes | Yes |
| kp\_connect\_devices | Yes | Yes |
| kp\_connect\_devices\_without\_check | Yes (New) | Yes (New) |
| kp\_disconnect\_devices | Yes | Yes |
| kp\_set\_timeout | Yes | Yes |
| kp\_reset\_device | Yes | Yes |
| kp\_load\_firmware/kp\_load\_firmware\_from\_file | Yes | Yes |
| kp\_load\_model/kp\_load\_model\_from\_file | Yes | Yes |
| kp\_load\_encrypted\_models/kp\_load\_encrypted\_models\_from\_file | Yes | Yes |
| kp\_enable\_firmware\_log | Yes | Yes |
| kp\_disable\_firmware\_log | Yes | Yes |
| kp\_get\_system\_info | Yes | Yes |
| kp\_get\_model\_info | Yes | Yes |
| kp\_load\_model\_from\_flash | Yes | Yes |
| kp\_install\_driver\_for\_windows | Yes | Yes |
| kp\_store\_ddr\_manage\_attr | Yes (New) | Yes (New) |
| kp\_error\_string | Yes | |
| kp\_get\_version | Yes | Yes |
| Function Name | C | Python |
| ----------------------------------------------------------- | --- | ------ |
| kp_scan_devices | Yes | Yes |
| kp_connect_devices | Yes | Yes |
| kp_connect_devices_without_check | Yes | Yes |
| kp_disconnect_devices | Yes | Yes |
| kp_set_timeout | Yes | Yes |
| kp_reset_device | Yes | Yes |
| kp_load_firmware/kp_load_firmware_from_file | Yes | Yes |
| kp_load_model/kp_load_model_from_file | Yes | Yes |
| kp_load_encrypted_models/kp_load_encrypted_models_from_file | Yes | Yes |
| kp_enable_firmware_log | Yes | Yes |
| kp_disable_firmware_log | Yes | Yes |
| kp_get_system_info | Yes | Yes |
| kp_get_model_info | Yes | Yes |
| kp_load_model_from_flash | Yes | Yes |
| kp_install_driver_for_windows | Yes | Yes |
| kp_store_ddr_manage_attr | Yes | Yes |
| kp_error_string | Yes | |
| kp_get_version | Yes | Yes |

* **Inference API**

| Function Name | C | Python |
| -------------------------------------------------- | --------- | --------- |
| kp\_inference\_configure | Yes | Yes |
| kp\_generic\_image\_inference\_send | Yes (New) | Yes (New) |
| kp\_generic\_image\_inference\_receive | Yes (New) | Yes (New) |
| kp\_generic\_data\_inference\_send | Yes (New) | Yes (New) |
| kp\_generic\_data\_inference\_receive | Yes (New) | Yes (New) |
| kp\_generic\_inference\_retrieve\_raw\_fixed\_node | Yes | |
| kp\_generic\_inference\_retrieve\_fixed\_node | Yes | Yes |
| kp\_generic\_inference\_retrieve\_float\_node | Yes | Yes |
| kp\_customized\_inference\_send | Yes | |
| kp\_customized\_inference\_receive | Yes | |
| kp\_customized\_command\_send | Yes | |
| kp\_dbg\_set\_enable\_checkpoints | Yes | |
| kp\_dbg\_receive\_checkpoint\_data | Yes | |
| kp\_profile\_set\_enable | Yes | |
| kp\_profile\_get\_statistics | Yes | |
| Function Name | C | Python |
| -------------------------------------------- | --------- | --------- |
| kp_inference_configure | Yes | Yes |
| kp_generic_image_inference_send | Yes | Yes |
| kp_generic_image_inference_receive | Yes | Yes |
| kp_generic_data_inference_send | Yes | Yes |
| kp_generic_data_inference_receive | Yes | Yes |
| kp_generic_inference_retrieve_raw_fixed_node | Yes | |
| kp_generic_inference_retrieve_fixed_node | Yes | Yes |
| kp_generic_inference_retrieve_float_node | Yes | Yes |
| kp_customized_inference_send | Yes | |
| kp_customized_inference_receive | Yes | |
| kp_customized_command_send | Yes | |
| kp_dbg_set_enable_checkpoints | Yes | |
| kp_dbg_receive_checkpoint_data | Yes | |
| kp_profile_set_enable | Yes (New) | Yes (New) |
| kp_profile_get_statistics | Yes (New) | Yes (New) |

* **Inference API V1.x (Legacy)**

| Function Name | C | Python |
| ------------------------------------------------------- | --- | ------ |
| kp\_generic\_raw\_inference\_send | Yes | Yes |
| kp\_generic\_raw\_inference\_receive | Yes | Yes |
| kp\_generic\_raw\_inference\_bypass\_pre\_proc\_send | Yes | Yes |
| kp\_generic\_raw\_inference\_bypass\_pre\_proc\_receive | Yes | Yes |
| Function Name | C | Python |
| ------------------------------------------------ | --- | ------ |
| kp_generic_raw_inference_send | Yes | Yes |
| kp_generic_raw_inference_receive | Yes | Yes |
| kp_generic_raw_inference_bypass_pre_proc_send | Yes | Yes |
| kp_generic_raw_inference_bypass_pre_proc_receive | Yes | Yes |
5 changes: 4 additions & 1 deletion docs/plus_c/feature_guide/customized_api/create_kl630_multiple_models_example.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

Note: **{PLUS_FOLDER_PATH}** will be used below for representing the unzipped folder path of PLUS.

3. Download the latest **KL630_SDK_vXXX.zip** into Ubuntu from <https://www.kneron.com/tw/support/developers/>. It is located at **KL620 SDK** section.
3. Please contact Kneron to obtain the latest **KL630_SDK_vXXX.zip**.

Note: KL630 SDK can only be developed on Ubuntu

Expand Down Expand Up @@ -275,6 +275,9 @@
---
## 3. Firmware Development for pedestrian detection + pedestrian classification
**Note**: For further information of KL630 VMF_NNM, please refer **Vienna_NNM_Programming_Guide.pdf** in {KL630_SDK_TOP_FOLDER_PATH}/03_SDK/01_Documents/
1. Go to App Flow Folder {KL630_SDK_FOLDER_PATH}/apps/vmf_nnm/solution/app_flow
2. Add *my_kl630_mul_example_inf.h* into include folder
Expand Down
4 changes: 3 additions & 1 deletion docs/plus_c/feature_guide/customized_api/create_kl630_single_model_example.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

Note: **{PLUS_FOLDER_PATH}** will be used below for representing the unzipped folder path of PLUS.

3. Download the latest **KL630_SDK_vXXX.zip** into Ubuntu from <https://www.kneron.com/tw/support/developers/>. It is located at **KL620 SDK** section.
3. Please contact Kneron to obtain the latest **KL630_SDK_vXXX.zip**.

Note: KL630 SDK can only be developed on Ubuntu

Expand Down Expand Up @@ -255,6 +255,8 @@
## 3. Firmware Development
**Note**: For further information of KL630 VMF_NNM, please refer **Vienna_NNM_Programming_Guide.pdf** in {KL630_SDK_TOP_FOLDER_PATH}/03_SDK/01_Documents/
1. Go to App Flow Folder {KL630_SDK_FOLDER_PATH}/apps/vmf_nnm/solution/app_flow
2. Add *my_kl630_sin_example_inf.h* into include folder
Expand Down
2 changes: 2 additions & 0 deletions docs/plus_c/feature_guide/customized_api/run_customized_examples.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,8 @@ $ bash build.sh

*If build succeeded, **kp_firmware.tar** will be put into {KL630_SDK_FOLDER_PATH}/apps/vmf_nnm/bin/

*For further information of building firmware of KL630, please refer **Vienna_NNM_Example_User_Guide.pdf** in {KL630_SDK_TOP_FOLDER_PATH}/03_SDK/01_Documents/

### 1.3 KL720 SCPU
1. Execute Keil uVision5

Expand Down
Loading

0 comments on commit 481e437

Please sign in to comment.