Merge pull request #44 from WeiChe-Huang/master

Fix KneronPLUS Python API V3.0.0 Document Missing Issue
kneron · Dec 18, 2024 · 137e41e · 137e41e
2 parents a6698b0 + 944531d
commit 137e41e
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 6 deletions.
diff --git a/.github/workflows/python-app.yml b/.github/workflows/python-app.yml
@@ -22,10 +22,10 @@ jobs:
       uses: actions/checkout@v3
       with:
         lfs: true
-    - name: Set up Python 3.7
+    - name: Set up Python 3.9
       uses: actions/setup-python@v3
       with:
-        python-version: "3.7"
+        python-version: "3.9"
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip

diff --git a/docs/plus_python/introduction/run_examples.md b/docs/plus_python/introduction/run_examples.md
@@ -2,7 +2,7 @@
 
 The provided examples are designed to show how to use KP APIs and present Kneron Device features. Error handling, wording and application layer features are not covered. They are open for more creatives.
 
-> **Note 1**: In the inference related examples, we are using KL520 for most demo. If you wish to use KL630, KL720, or KL730, just change the prefix of the example name from kl520 to kl630, kl720, or kl730.
+> **Note 1**: In the inference related examples, we are using KL520 for most demo. If you wish to use KL630, KL720, or KL730 (alpha), just change the prefix of the example name from kl520 to kl630, kl720, or kl730.
 
 > **Note 2**: **[Ubuntu]** Please update Kneron device USB permission before following steps on Ubuntu. See the [Installation
 ](./install_dependency.md) for details.

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -15,7 +15,7 @@ markdown_extensions:
 
 nav:
   - Kneron AI:                                                      index.md
-  - Kneron PLUS - C:
+  - Kneron PLUS 3 - C:
     - Index:                                                        plus_c/README.md
     - Getting Started:                                              plus_c/getting_started.md
     - Introduction:
@@ -106,7 +106,7 @@ nav:
           - Data Structure:                                         plus_c_api/api_reference_1.0.x/kp_struct.h.md
           - Core API:                                               plus_c_api/api_reference_1.0.x/kp_core.h.md
           - Inference API:                                          plus_c_api/api_reference_1.0.x/kp_inference.h.md
-  - Kneron PLUS - Python:
+  - Kneron PLUS 3 - Python:
     - Index:                                                        plus_python/README.md
     - Getting Started:                                              plus_python/getting_start.md
     - Introduction:
@@ -147,7 +147,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.3.0 (Latest Version):
+      - V3.0.0 (Latest Version):
+        - Index:                                                    plus_python/api_document/V3.0.0/index.md
+        - kp.core:                                                  plus_python/api_document/V3.0.0/kp/core.md
+        - kp.inference:                                             plus_python/api_document/V3.0.0/kp/inference.md
+        - kp value:                                                 plus_python/api_document/V3.0.0/kp/value.md
+        - kp enum:                                                  plus_python/api_document/V3.0.0/kp/enum.md
+        - kp exception:                                             plus_python/api_document/V3.0.0/kp/exception.md
+        - kp const:                                                 plus_python/api_document/V3.0.0/kp/const.md
+        - kp.v1 (Legacy Module):
+          - kp.v1.inference:                                        plus_python/api_document/V3.0.0/kp/v1/inference.md
+          - kp.v1 value:                                            plus_python/api_document/V3.0.0/kp/v1/value.md
+      - V2.3.0:
         - Index:                                                    plus_python/api_document/V2.3.0/index.md
         - kp.core:                                                  plus_python/api_document/V2.3.0/kp/core.md
         - kp.inference:                                             plus_python/api_document/V2.3.0/kp/inference.md