diff --git a/docs/index.md b/docs/index.md index 342d1e8..9c151bb 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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* diff --git a/docs/plus_c/appendix/api_support_list.md b/docs/plus_c/appendix/api_support_list.md index 8094b84..a7306ea 100644 --- a/docs/plus_c/appendix/api_support_list.md +++ b/docs/plus_c/appendix/api_support_list.md @@ -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 | diff --git a/docs/plus_c/feature_guide/customized_api/create_kl630_multiple_models_example.md b/docs/plus_c/feature_guide/customized_api/create_kl630_multiple_models_example.md index 91df938..2709b58 100644 --- a/docs/plus_c/feature_guide/customized_api/create_kl630_multiple_models_example.md +++ b/docs/plus_c/feature_guide/customized_api/create_kl630_multiple_models_example.md @@ -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 . 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 @@ -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 diff --git a/docs/plus_c/feature_guide/customized_api/create_kl630_single_model_example.md b/docs/plus_c/feature_guide/customized_api/create_kl630_single_model_example.md index 1041c49..f7ced5e 100644 --- a/docs/plus_c/feature_guide/customized_api/create_kl630_single_model_example.md +++ b/docs/plus_c/feature_guide/customized_api/create_kl630_single_model_example.md @@ -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 . 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 @@ -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 diff --git a/docs/plus_c/feature_guide/customized_api/run_customized_examples.md b/docs/plus_c/feature_guide/customized_api/run_customized_examples.md index 7eedaf5..e806786 100644 --- a/docs/plus_c/feature_guide/customized_api/run_customized_examples.md +++ b/docs/plus_c/feature_guide/customized_api/run_customized_examples.md @@ -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 diff --git a/docs/plus_c/introduction/introduction.md b/docs/plus_c/introduction/introduction.md index 467f4d3..b5cbe8f 100644 --- a/docs/plus_c/introduction/introduction.md +++ b/docs/plus_c/introduction/introduction.md @@ -31,54 +31,57 @@ Below gives some definitions regarding the Kneron PLUS: The features which PLUS Supported are listed below: -Index | Category | Supported Item | Minimum Version | KL520 | KL720 | KL630 -------- | :-------------------- | :------------------------------------------------------------------------ | :---------------- | :---: | :---: | :---: -1 | Image Format | RGBA8888 , RAW8 , Packed YCbCr422 (YUYV422) , RGB565 | | | | -2 | | Planar YUV420 | v2.1.0 | X | X | -3 | System | Firmware In Flash | | | | -4 | | Model In Flash | | | | -5 | | Runtime Upload Firmware | | | X | -6 | | Runtime Upload Model | | | | -7 | | Software Reset | | | | -8 | | Software Shutdown (Developing Broad Only) | | | X | X -9 | | Software Reboot | | | | -10 | | Scan Devices | | | | -11 | | Device Log via USB | | | | -12 | | Device Connection : All Devices, Specified Device(s) | | | | -13 | Inference | Flexible Send / Receive Inference | | | | -14 | | Multiple Device Auto Dispatch | | | | -15 | | Enable / Disable Pre-process on Device | | | | -16 | | Enable / Disable Post-process on Device | | | | -17 | | Output Floating Point / Fixed Point Result | | | | -18 | | Enable / Disable Debug Checkpoints | v1.3.0 | | | -19 | | Enable / Disable Execution Time Profiling | v1.3.0 | | | -20 | System / Model Info | Get Firmware Version | | | | -21 | | Get KN Number | | | | -22 | | Get Model CRC | | | | -23 | | Get Model Info | | | | -24 | | Install Device Driver for Windows | v1.3.0 | | | -25 | Application API | Generic Image Inference | v2.0.0 | | | -26 | | Generic Data Inference | v2.0.0 | | | -27 | | Customized Inference (C code only) | | | | -28 | | User Define API (C code only) | | | | -29 | System Examples | Get Firmware Info | | | | -30 | | Get Model Info | | | | -31 | | Reboot Device | | | | -32 | | Shutdown Device | | | X | X -33 | | Device FIFO Queue Config Example | v2.0.0 | | | -34 | Inference Examples | Generic Image Inference (Raw Output) | v2.0.0 | | | -35 | | Generic Image Inference (with Crop) | v2.0.0 | | | -36 | | Generic Image Inference (with Post Process on Host Side) | v2.0.0 | | | -37 | | Generic Image Inference (Multiple Threads) | v2.0.0 | | | -38 | | Generic Image Inference (Model in Flash) | v2.0.0 | | | -39 | | Generic Image Inference (Web Cam with Drop Frame) | v2.0.0 | | | -40 | | Generic Data Inference (with Pre Process on Host Side) | v2.0.0 | | | -41 | | User Define API Inference (Yolo with Config Post Process) (C code only) | v1.3.0 | | | -42 | | Customized Inference with Single Model (C code only) | v2.0.0 for KL720 | | | -43 | | Customized Inference with Multiple Models (C code only) | v2.0.0 for KL720 | | | -44 | Debug Examples | Debug Checkpoints Example | v1.3.0 | | X | X -45 | | Execution Time Profiling Example | v1.3.0 | | X | X -46 | Model Zoo Examples | Simple examples for pre-trained models | | | | X +Index | Category | Supported Item | Min Version (KL520/KL720) | Min Version (KL630) [***1***] | KL520 | KL720 | KL630 +------- | :-------------------- | :------------------------------------------------------------------------ | :------------------------ | :---------------------------- | :---: | :---: | :---: +1 | Image Format | RGBA8888 , RAW8 , Packed YCbCr422 (YUYV422) , RGB565 | | | | | +2 | | Planar YUV420 | | | X | X | +3 | System | Firmware In Flash | | | | | +4 | | Model In Flash | | | | | +5 | | Runtime Upload Firmware | | | | X | +6 | | Runtime Upload Model | | | | | +7 | | Software Reset | | | | | +8 | | Software Shutdown (Developing Broad Only) | | | | X | X +9 | | Software Reboot | | | | | +10 | | Scan Devices | | | | | +11 | | Device Log via USB | | | | | +12 | | Device Connection : All Devices, Specified Device(s) | | | | | +13 | Inference | Flexible Send / Receive Inference | | | | | +14 | | Multiple Device Auto Dispatch | | | | | +15 | | Enable / Disable Pre-process on Device | | | | | +16 | | Enable / Disable Post-process on Device | | | | | +17 | | Output Floating Point / Fixed Point Result | | | | | +18 | | Enable / Disable Debug Checkpoints | v1.3.0 | | | | +19 | | Enable / Disable Execution Time Profiling | v1.3.0 | | | | +20 | System / Model Info | Get Firmware Version | | | | | +21 | | Get KN Number | | | | | +22 | | Get Model CRC | | | | | +23 | | Get Model Info | | | | | +24 | | Install Device Driver for Windows | v1.3.0 | | | | +25 | Application API | Generic Image Inference | v2.0.0 | | | | +26 | | Generic Data Inference | v2.0.0 | | | | +27 | | Customized Inference (C code only) | | | | | +28 | | User Define API (C code only) | | | | | +29 | System Examples | Get Firmware Info | | | | | +30 | | Get Model Info | | | | | +31 | | Reboot Device | | | | | +32 | | Shutdown Device | | | | X | X +33 | | Device FIFO Queue Config Example | v2.0.0 | | | | +34 | Inference Examples | Generic Image Inference (Raw Output) | v2.0.0 | | | | +35 | | Generic Image Inference (with Crop) | v2.0.0 | | | | +36 | | Generic Image Inference (with Post Process on Host Side) | v2.0.0 | | | | +37 | | Generic Image Inference (Multiple Threads) | v2.0.0 | | | | +38 | | Generic Image Inference (Model in Flash) | v2.0.0 | | | | +39 | | Generic Image Inference (Web Cam with Drop Frame) | v2.0.0 | | | | +40 | | Generic Data Inference (with Pre Process on Host Side) | v2.0.0 | | | | +41 | | User Define API Inference (Yolo with Config Post Process) (C code only) | v1.3.0 | | | | +42 | | Customized Inference with Single Model (C code only) | v2.0.0 for KL720 | | | | +43 | | Customized Inference with Multiple Models (C code only) | v2.0.0 for KL720 | | | | +44 | Debug Examples | Debug Checkpoints Example | v1.3.0 | | | X | X +45 | | Execution Time Profiling Example | v1.3.0 | | | X | X +46 | Model Zoo Examples | Simple examples for pre-trained models | | | | | X + +**Note**: +- [1] If the minimum version is not written, this feature is supported from v2.1.1. The following components are contained in Kneron PLUS: @@ -99,18 +102,23 @@ Besides the basic features, there are few advanced features provided in Kneron P **Note**: Most of the advanced features and examples are C code only. Only **Update Kdp2 to Kdp2 Flash Boot** has the python version example. -Index | Category | Supported Item | Minimum Version | KL520 | KL720 | KL630 -------- | :-------------------- | :-------------------------------------------------------- | :---------------- | :---: | :---: | :---: -1 | System | Runtime Upload Firmware via UART | | | X | X -2 | | Hico Mode (MIPI image input, Companion Result Output) | | X | | -2 | Examples | Update Kdp to Kdp2 Usb Boot | | | X | X -3 | | Update Kdp2 to Kdp2 Usb Boot | | | X | -4 | | Update Kdp to Kdp2 Flash Boot | | | | X -5 | | Update Kdp2 to Kdp2 Flash Boot | | | | -6 | | Update Model to Flash | | | | -7 | | Upload Firmware via UART | | | X | X -8 | | Upload Firmware via Usb for No-Flash Device | v2.0.0 | X | | X -9 | | Read / Write Device Memory | | | | X -10 | | Access Firmware Log via USB | | X | | X -11 | | Hico Cam Inference (Kneron LW 3D module is required) | | X | | -12 | | Hico ToF Inference (Kneron ToF module is required) | v1.3.0 | X | | X +Index | Category | Supported Item | Min Version (KL520/KL720) | Min Version (KL630) | KL520 | KL720 | KL630 +------- | :-------------------- | :-------------------------------------------------------- | :------------------------ | :-------------------- | :---: | :---: | :---: +1 | System | Runtime Upload Firmware via UART | | | | X | X +2 | | Hico Mode (MIPI image input, Companion Result Output) | | v2.1.1 | X | | +2 | Examples | Update Kdp to Kdp2 Usb Boot | | | | X | X +3 | | Update Kdp2 to Kdp2 Usb Boot | | v2.1.1 | | X | +4 | | Update Kdp to Kdp2 Flash Boot | | | | | X +5 | | Update Kdp2 to Kdp2 Flash Boot | | v2.1.1 | | | +6 | | Update Model to Flash | | v2.1.1 | | | +7 | | Upload Firmware via UART | | | | X | X +8 | | Upload Firmware via Usb for No-Flash Device | v2.0.0 | | X | | X +9 | | Read / Write Device Memory | | | | | X +10 | | Access Firmware Log via USB | | | X | | X +11 | | Hico Cam Inference [***1***] [***2***] | | v2.1.1 | X | | +12 | | Hico ToF Inference (Kneron ToF module is required) | v1.3.0 | | X | | X + +**Note**: + +- [1] For Hico Mipi on KL720, Kneron LW 3D module is required. +- [2] For Hico Mipi on KL630, Vatics CIS-OS05A10-EVM-1.0.0 module is required. diff --git a/docs/plus_c/modelzoo/index.md b/docs/plus_c/modelzoo/index.md index 6e7f29c..0172c4d 100644 --- a/docs/plus_c/modelzoo/index.md +++ b/docs/plus_c/modelzoo/index.md @@ -27,5 +27,5 @@ In addition, the **Kneron PLUS** provides `Generic Image Inference` and `Gener ### Reference -- [Toolchain Docker](http://doc.kneron.com/docs/#toolchain/manual/#2-toolchain-docker-overview) -- [Model Training](../../model_training//index.md) +- [Toolchain Docker](https://doc.kneron.com/docs/#toolchain/manual_1_overview/) +- [Model Training](https://doc.kneron.com/docs/#model_training/) diff --git a/docs/plus_c/modelzoo/kn-model-zoo_generic_inference_classification.md b/docs/plus_c/modelzoo/kn-model-zoo_generic_inference_classification.md index ff527a8..aac2d0c 100644 --- a/docs/plus_c/modelzoo/kn-model-zoo_generic_inference_classification.md +++ b/docs/plus_c/modelzoo/kn-model-zoo_generic_inference_classification.md @@ -1,7 +1,7 @@ # Kneron Model Zoo Inference Example - Classification PLUS Inference Example with NEF model trained from -http://doc.kneron.com/docs/#model_training/classification/ +https://doc.kneron.com/docs/#model_training/classification/ --- @@ -10,12 +10,12 @@ Check in -- Kneron Toolchain docker (doc: http://doc.kneron.com/docs/#toolchain/manual/#2-toolchain-docker-overview) +- Kneron Toolchain docker (doc: https://doc.kneron.com/docs/#toolchain/manual_1_overview/) to learn how to train a the example model, and check -- http://doc.kneron.com/docs/#toolchain/manual/#2-toolchain-docker-overview -- http://doc.kneron.com/docs/#toolchain/yolo_example/ +- https://doc.kneron.com/docs/#toolchain/manual_1_overview/ +- https://doc.kneron.com/docs/#toolchain/appendix/yolo_example/ to learn how to convert the trained model to NEF model diff --git a/docs/plus_c/modelzoo/kn-model-zoo_generic_inference_post_fcos.md b/docs/plus_c/modelzoo/kn-model-zoo_generic_inference_post_fcos.md index c3230fd..bfa9137 100644 --- a/docs/plus_c/modelzoo/kn-model-zoo_generic_inference_post_fcos.md +++ b/docs/plus_c/modelzoo/kn-model-zoo_generic_inference_post_fcos.md @@ -1,7 +1,7 @@ # Kneron Model Zoo Inference Example - Detection(FCOS) PLUS Inference Example with NEF model trained from -http://doc.kneron.com/docs/#model_training/detection/fcos +https://doc.kneron.com/docs/#model_training/object_detection_fcos/ --- @@ -10,12 +10,12 @@ Check in -- Kneron Toolchain docker (doc: http://doc.kneron.com/docs/#toolchain/manual/#2-toolchain-docker-overview) +- Kneron Toolchain docker (doc: https://doc.kneron.com/docs/#toolchain/manual_1_overview/) to learn how to train a the example model, and check -- http://doc.kneron.com/docs/#toolchain/manual/#2-toolchain-docker-overview -- http://doc.kneron.com/docs/#toolchain/yolo_example/ +- https://doc.kneron.com/docs/#toolchain/manual_1_overview/ +- https://doc.kneron.com/docs/#toolchain/appendix/yolo_example/ to learn how to convert the trained model to NEF model diff --git a/docs/plus_c/modelzoo/kn-model-zoo_generic_inference_post_yolov5.md b/docs/plus_c/modelzoo/kn-model-zoo_generic_inference_post_yolov5.md index 4fca60c..7f77189 100644 --- a/docs/plus_c/modelzoo/kn-model-zoo_generic_inference_post_yolov5.md +++ b/docs/plus_c/modelzoo/kn-model-zoo_generic_inference_post_yolov5.md @@ -1,7 +1,7 @@ # Kneron Model Zoo Inference Example - Detection(Yolov5) PLUS Inference Example with NEF model trained from -http://doc.kneron.com/docs/#model_training/detection/yolov5 +https://doc.kneron.com/docs/#model_training/object_detection_yolov5/ --- @@ -10,12 +10,12 @@ Check in -- Kneron Toolchain docker (doc: http://doc.kneron.com/docs/#toolchain/manual/#2-toolchain-docker-overview) +- Kneron Toolchain docker (doc: https://doc.kneron.com/docs/#toolchain/manual_1_overview/) to learn how to train a the example model, and check -- http://doc.kneron.com/docs/#toolchain/manual/#2-toolchain-docker-overview -- http://doc.kneron.com/docs/#toolchain/yolo_example/ +- https://doc.kneron.com/docs/#toolchain/manual_1_overview/ +- https://doc.kneron.com/docs/#toolchain/appendix/yolo_example/ to learn how to convert the trained model to NEF model diff --git a/docs/plus_python/feature_guide/chapter/device_ddr_management.md b/docs/plus_python/feature_guide/chapter/device_ddr_management.md index 5b13b09..7d0c836 100644 --- a/docs/plus_python/feature_guide/chapter/device_ddr_management.md +++ b/docs/plus_python/feature_guide/chapter/device_ddr_management.md @@ -70,4 +70,4 @@ class DdrManageAttributes(ValueBase, ValueRepresentBase): 4. If (System Reserved + Model Size + (Input Buffer Count x Input Buffer Size) + (Result Buffer Count x Result Buffer Size)) is larger than the available DDR space, the configuration will fail. -Please refer [6. Device Memory Usage Control Example](../../introduction/run_examples.md#6-device-memory-usage-control-example) for the demonstration. +Please refer [9. Device Memory Usage Control Example](../../introduction/run_examples.md#9-device-memory-usage-control-example) for the demonstration. diff --git a/docs/plus_python/getting_start.md b/docs/plus_python/getting_start.md index 218643a..73cf2c3 100644 --- a/docs/plus_python/getting_start.md +++ b/docs/plus_python/getting_start.md @@ -94,6 +94,7 @@ $ sudo sh KneronDFUT.sh --help * Select the AI device to be update to KDP2 firmware * Push **Run** button + \(**Update to USB Boot** should be checked by default\) ![](./imgs/dfut_kl520_usb_boot.png) @@ -125,7 +126,22 @@ $ sudo sh KneronDFUT.sh --help ==== Update of Device with Port Id: 133 Succeeded ==== ``` -### 2.2 KL720 +### 2.2 KL630 + +1. Use GUI to Update AI Device + + ```bash + $ sudo sh KneronDFUT.sh + ``` + + * Select the AI device to be update to KDP2 firmware + + * Push **Run** button + \(**Update to USB Boot** should be checked by default\) + + ![](./imgs/dfut_kl630_usb_boot.png) + +### 2.3 KL720 1. Use GUI to Update AI Device diff --git a/docs/plus_python/introduction/introduction.md b/docs/plus_python/introduction/introduction.md index 7c22147..2514d0b 100644 --- a/docs/plus_python/introduction/introduction.md +++ b/docs/plus_python/introduction/introduction.md @@ -101,16 +101,16 @@ Besides the basic features, there are few advanced features provided in Kneron P Index | Category | Supported Item | Minimum Version | KL520 | KL720 | KL630 ------- | :-------------------- | :-------------------------------------------------------- | :---------------- | :---: | :---: | :---: -1 | System | Runtime Upload Firmware via UART | | | X | X -2 | | Hico Mode (MIPI image input, Companion Result Output) | | X | | +1 | System | Runtime Upload Firmware via UART | | X | X | X +2 | | Hico Mode (MIPI image input, Companion Result Output) | | X | | X 2 | Examples | Update Kdp to Kdp2 Usb Boot | | | X | X 3 | | Update Kdp2 to Kdp2 Usb Boot | | | X | 4 | | Update Kdp to Kdp2 Flash Boot | | | | X 5 | | Update Kdp2 to Kdp2 Flash Boot | | | | 6 | | Update Model to Flash | | | | -7 | | Upload Firmware via UART | | | X | X +7 | | Upload Firmware via UART | | X | X | X 8 | | Upload Firmware via Usb for No-Flash Device | v2.0.0 | X | | X -9 | | Read / Write Device Memory | | | | X +9 | | Read / Write Device Memory | | X | X | X 10 | | Access Firmware Log via USB | | X | | X -11 | | Hico Cam Inference (Kneron LW 3D module is required) | | X | | -12 | | Hico ToF Inference (Kneron ToF module is required) | v1.3.0 | X | | X +11 | | Hico Cam Inference (Kneron LW 3D module is required) | | X | X | X +12 | | Hico ToF Inference (Kneron ToF module is required) | v1.3.0 | X | X | X diff --git a/docs/plus_python/introduction/run_examples.md b/docs/plus_python/introduction/run_examples.md index a730ccb..58ea6bc 100644 --- a/docs/plus_python/introduction/run_examples.md +++ b/docs/plus_python/introduction/run_examples.md @@ -480,7 +480,7 @@ This example is to show how to configure the `kp.DdrManageAttributes` and the us Please refer [Device DDR Management](../feature_guide/chapter/device_ddr_management.md) for more information. ```bash -$ python3 +$ python3 KL520DemoGenericImageInferenceFifoqConfig.py [Connect Device] - Success diff --git a/docs/plus_python/modelzoo/chapter/ByteTrack.md b/docs/plus_python/modelzoo/chapter/ByteTrack.md index d63de70..6d72c86 100644 --- a/docs/plus_python/modelzoo/chapter/ByteTrack.md +++ b/docs/plus_python/modelzoo/chapter/ByteTrack.md @@ -1,7 +1,7 @@ # Kneron Model Zoo PLUS Inference Example - ByteTrack (Object Tracking) NEF model trained from -http://doc.kneron.com/docs/#model_training/OpenMMLab/ByteTrack.md +http://doc.kneron.com/docs/#model_training/OpenMMLab/ByteTrack --- diff --git a/docs/plus_python/modelzoo/chapter/RSN18.md b/docs/plus_python/modelzoo/chapter/RSN18.md index 2d459da..4263345 100644 --- a/docs/plus_python/modelzoo/chapter/RSN18.md +++ b/docs/plus_python/modelzoo/chapter/RSN18.md @@ -1,7 +1,7 @@ # Kneron Model Zoo PLUS Inference Example - RSN18 (Pose Estimate) NEF model trained from -http://doc.kneron.com/docs/#model_training/OpenMMLab/RSN18.md +http://doc.kneron.com/docs/#model_training/OpenMMLab/RSN18 --- diff --git a/docs/plus_python/modelzoo/chapter/RegNet.md b/docs/plus_python/modelzoo/chapter/RegNet.md index 7751090..a743d17 100644 --- a/docs/plus_python/modelzoo/chapter/RegNet.md +++ b/docs/plus_python/modelzoo/chapter/RegNet.md @@ -1,7 +1,7 @@ # Kneron Model Zoo PLUS Inference Example - RegNet (Classification) NEF model trained from -http://doc.kneron.com/docs/#model_training/OpenMMLab/RegNet.md +http://doc.kneron.com/docs/#model_training/OpenMMLab/RegNet --- diff --git a/docs/plus_python/modelzoo/chapter/STDC.md b/docs/plus_python/modelzoo/chapter/STDC.md index 7c6afe2..00aa11b 100644 --- a/docs/plus_python/modelzoo/chapter/STDC.md +++ b/docs/plus_python/modelzoo/chapter/STDC.md @@ -1,7 +1,7 @@ # Kneron Model Zoo PLUS Inference Example - STDC (Segmentation) NEF model trained from -http://doc.kneron.com/docs/#model_training/OpenMMLab/STDC.md +http://doc.kneron.com/docs/#model_training/OpenMMLab/STDC --- diff --git a/docs/plus_python/modelzoo/chapter/YoloX.md b/docs/plus_python/modelzoo/chapter/YoloX.md index ddd41a9..f73f5de 100644 --- a/docs/plus_python/modelzoo/chapter/YoloX.md +++ b/docs/plus_python/modelzoo/chapter/YoloX.md @@ -1,7 +1,7 @@ # Kneron Model Zoo PLUS Inference Example - YoloX (Object Detection) NEF model trained from -http://doc.kneron.com/docs/#model_training/OpenMMLab/YoloX.md +http://doc.kneron.com/docs/#model_training/OpenMMLab/YoloX --- diff --git a/docs/plus_python/modelzoo/chapter/kn-model-zoo_generic_inference_classification.md b/docs/plus_python/modelzoo/chapter/kn-model-zoo_generic_inference_classification.md index a9e208a..4f6348e 100644 --- a/docs/plus_python/modelzoo/chapter/kn-model-zoo_generic_inference_classification.md +++ b/docs/plus_python/modelzoo/chapter/kn-model-zoo_generic_inference_classification.md @@ -1,7 +1,7 @@ # Kneron Model Zoo Inference 520 Example - Classification KL520 Inference Example with NEF model trained from -http://doc.kneron.com/docs/#model_training/classification/ +https://doc.kneron.com/docs/#model_training/classification/ --- @@ -11,12 +11,12 @@ Check in -- Kneron Toolchain docker (doc: http://doc.kneron.com/docs/#toolchain/manual/#2-toolchain-docker-overview) +- Kneron Toolchain docker (doc: https://doc.kneron.com/docs/#toolchain/manual_1_overview/) to learn how to train a the example model, and check -- http://doc.kneron.com/docs/#toolchain/manual/#2-toolchain-docker-overview -- http://doc.kneron.com/docs/#toolchain/yolo_example/ +- https://doc.kneron.com/docs/#toolchain/manual_1_overview/ +- https://doc.kneron.com/docs/#toolchain/appendix/yolo_example/ to learn how to convert the trained model to NEF model diff --git a/docs/plus_python/modelzoo/chapter/kn-model-zoo_generic_inference_post_fcos.md b/docs/plus_python/modelzoo/chapter/kn-model-zoo_generic_inference_post_fcos.md index b1a7300..addbba2 100644 --- a/docs/plus_python/modelzoo/chapter/kn-model-zoo_generic_inference_post_fcos.md +++ b/docs/plus_python/modelzoo/chapter/kn-model-zoo_generic_inference_post_fcos.md @@ -1,7 +1,7 @@ # Kneron Model Zoo Inference 520 Example - Detection(FCOS) KL520 Inference Example with NEF model trained from -http://doc.kneron.com/docs/#model_training/detection/fcos +https://doc.kneron.com/docs/#model_training/object_detection_fcos/ --- @@ -11,12 +11,12 @@ Check in -- Kneron Toolchain docker (doc: http://doc.kneron.com/docs/#toolchain/manual/#2-toolchain-docker-overview) +- Kneron Toolchain docker (doc: https://doc.kneron.com/docs/#toolchain/manual_1_overview/) to learn how to train a the example model, and check -- http://doc.kneron.com/docs/#toolchain/manual/#2-toolchain-docker-overview -- http://doc.kneron.com/docs/#toolchain/yolo_example/ +- https://doc.kneron.com/docs/#toolchain/manual_1_overview/ +- https://doc.kneron.com/docs/#toolchain/appendix/yolo_example/ to learn how to convert the trained model to NEF model diff --git a/docs/plus_python/modelzoo/chapter/kn-model-zoo_generic_inference_post_yolov5.md b/docs/plus_python/modelzoo/chapter/kn-model-zoo_generic_inference_post_yolov5.md index 7d87193..a5d4293 100644 --- a/docs/plus_python/modelzoo/chapter/kn-model-zoo_generic_inference_post_yolov5.md +++ b/docs/plus_python/modelzoo/chapter/kn-model-zoo_generic_inference_post_yolov5.md @@ -1,7 +1,7 @@ # Kneron Model Zoo Inference 520 Example - Detection(Yolov5) KL520 Inference Example with NEF model trained from -http://doc.kneron.com/docs/#model_training/detection/yolov5 +https://doc.kneron.com/docs/#model_training/object_detection_yolov5/ --- @@ -11,12 +11,12 @@ Check in -- Kneron Toolchain docker (doc: http://doc.kneron.com/docs/#toolchain/manual/#2-toolchain-docker-overview) +- Kneron Toolchain docker (doc: https://doc.kneron.com/docs/#toolchain/manual_1_overview/) to learn how to train a the example model, and check -- http://doc.kneron.com/docs/#toolchain/manual/#2-toolchain-docker-overview -- http://doc.kneron.com/docs/#toolchain/yolo_example/ +- https://doc.kneron.com/docs/#toolchain/manual_1_overview/ +- https://doc.kneron.com/docs/#toolchain/appendix/yolo_example/ to learn how to convert the trained model to NEF model diff --git a/docs/plus_python/modelzoo/index.md b/docs/plus_python/modelzoo/index.md index c462f23..3d9e7d5 100644 --- a/docs/plus_python/modelzoo/index.md +++ b/docs/plus_python/modelzoo/index.md @@ -27,5 +27,5 @@ In addition, the **Kneron PLUS** provides `Generic Image Inference` and `Gener ### Reference -- [Toolchain Docker](http://doc.kneron.com/docs/#toolchain/manual/#2-toolchain-docker-overview) -- [Model Training](../../model_training//index.md) +- [Toolchain Docker](https://doc.kneron.com/docs/#toolchain/manual_1_overview/) +- [Model Training](https://doc.kneron.com/docs/#model_training/) diff --git a/mkdocs.yml b/mkdocs.yml index 964d578..cccffd1 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -127,7 +127,18 @@ nav: - Compatible with V1.x API: plus_python/api_migration/chapter/api_compatible_legacy.md - API Document: - Index: plus_python/api_document/index.md - - V2.0.0 (Latest Version): + - V2.1.0 (Latest Version): + - Index: plus_python/api_document/V2.1.0/index.md + - kp.core: plus_python/api_document/V2.1.0/kp/core.md + - kp.inference: plus_python/api_document/V2.1.0/kp/inference.md + - kp value: plus_python/api_document/V2.1.0/kp/value.md + - kp enum: plus_python/api_document/V2.1.0/kp/enum.md + - kp exception: plus_python/api_document/V2.1.0/kp/exception.md + - kp const: plus_python/api_document/V2.1.0/kp/const.md + - kp.v1 (Legacy Module): + - kp.v1.inference: plus_python/api_document/V2.1.0/kp/v1/inference.md + - kp.v1 value: plus_python/api_document/V2.1.0/kp/v1/value.md + - V2.0.0: - Index: plus_python/api_document/V2.0.0/index.md - kp.core: plus_python/api_document/V2.0.0/kp/core.md - kp.inference: plus_python/api_document/V2.0.0/kp/inference.md