-
Notifications
You must be signed in to change notification settings - Fork 99
docs: rewrite O6/O6N docs. #1236
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
Conversation
|
This PR has too many files to review (>50 files). |
2a39a90 to
ffb6fa5
Compare
|
/windsurf-review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Other comments (16)
-
docs/common/orion-common/app-dev/artificial-intelligence/_ultra-fast-lane-detection-v2.mdx (72-72)
There's a typo in the build command. It should have a space between 'cixbuild' and the configuration file path.
cixbuild cfg/Ultra-Fast-Lane-Detection_v2build.cfg - docs/common/orion-common/app-dev/artificial-intelligence/_whisper-medium.mdx (20-20) There's a typo in the directory path: 'Speech_Recognotion' should be 'Speech_Recognition'. This appears in multiple places and could cause confusion for users following these instructions.
-
docs/common/orion-common/app-dev/artificial-intelligence/_pp-ocr-v4.mdx (19-24)
Missing `wget` command for the first download URL.
cd ai_model_hub_25_Q3/models/ComputeVision/Face_OCR/onnx_PP_OCRv4 wget https://www.modelscope.cn/models/cix/ai_model_hub_25_Q3/resolve/master/models/ComputeVision/OCR/onnx_PP_OCRv4/cls.cix wget https://www.modelscope.cn/models/cix/ai_model_hub_25_Q3/resolve/master/models/ComputeVision/OCR/onnx_PP_OCRv4/PP-OCRv4_det.cix wget https://www.modelscope.cn/models/cix/ai_model_hub_25_Q3/resolve/master/models/ComputeVision/OCR/onnx_PP_OCRv4/rec.cix -
docs/common/orion-common/app-dev/artificial-intelligence/_pp-ocr-v4.mdx (49-53)
Missing `wget` command for the first download URL.
cd ai_model_hub_25_Q3/models/ComputeVision/Face_OCR/onnx_PP_OCRv4/model wget https://www.modelscope.cn/models/cix/ai_model_hub_25_Q3/resolve/master/models/ComputeVision/OCR/onnx_PP_OCRv4/model/cls.onnx wget https://www.modelscope.cn/models/cix/ai_model_hub_25_Q3/resolve/master/models/ComputeVision/OCR/onnx_PP_OCRv4/model/PP-OCRv4_det.onnx wget https://www.modelscope.cn/models/cix/ai_model_hub_25_Q3/resolve/master/models/ComputeVision/OCR/onnx_PP_OCRv4/model/rec.onnx - docs/common/orion-common/app-dev/artificial-intelligence/_qwen2-5-vl-3b.mdx (59-59) The document references `requirements.txt` in the virtual environment setup, but it's not clear where this file comes from or what it contains. Consider adding information about the required dependencies or where to find this file.
- docs/common/orion-common/app-dev/artificial-intelligence/_API-manual.mdx (3-3) Consider using more descriptive link text instead of 'this' for better accessibility. For example: '[CIX Developer Center](https://developer.cixtech.com/)' would be more informative for users, especially those using screen readers.
- docs/common/orion-common/app-dev/artificial-intelligence/_qwen2-5-vl-3b.mdx (24-24) There's an inconsistency between the image path in the download section (`./test.png`) and the path shown in the model testing section (`./Qwen2.5-VL-3B-Instruct/test.png`). This might confuse users following the tutorial step by step.
- docs/common/orion-common/app-dev/artificial-intelligence/_qwen2vl-2b.mdx (58-58) The documentation references `requirements.txt` in the virtual environment setup section, but doesn't specify where this file comes from or what dependencies it should contain. Consider adding information about the required dependencies or how to obtain this file.
- docs/common/orion-common/app-dev/artificial-intelligence/_whisper-medium.mdx (169-169) The log output shows a future date (December 29, 2025) which is inconsistent with the current timeline. Consider updating this with a realistic date to avoid confusion for users following the documentation.
- docs/common/orion-common/app-dev/artificial-intelligence/_API-manual.mdx (5-5) The download instructions ('下拉找到文档资源,点击 AI 一栏的下载即可') may become outdated if the website layout changes. Consider providing a more direct link to the resources section if possible, or adding a screenshot to illustrate the navigation steps.
- docs/common/ai/_ernie-4_5-21b-a3b_llama_cpp.mdx (176-176) There's an inconsistency in the capitalization of 'llama.cpp'. Line 55 was updated to lowercase, but line 176 still uses 'Llama.cpp' in the link text. Consider using consistent capitalization throughout the document.
-
docs/common/orion-common/app-dev/artificial-intelligence/_env-setup.mdx (75-75)
There's an inconsistency between the command mentioned in the text and the actual command shown in the code block. Please ensure both are using the same command name.
cix-build -v -
docs/common/orion-common/app-dev/artificial-intelligence/_yolov8s-pose.mdx (9-11)
There's a formatting issue with the closing tag of the info block. The closing tag has extra spaces which might cause rendering problems.
- [环境配置](../../../../orion/o6/app-development/artificial-intelligence/env-setup.md) - [AI Model Hub](../../../../orion/o6/app-development/artificial-intelligence/ai-hub.md) ::: -
docs/common/orion-common/app-dev/artificial-intelligence/_real-esrgan.mdx (59-60)
There's a typo in the filename - 'inference_onnx.pyy' should be 'inference_onnx.py'.
├── inference_npu.py ├── inference_onnx.py - docs/common/orion-common/app-dev/artificial-intelligence/_qwen2-5-vl-3b.mdx (43-43) There's an inconsistency in the `tip` attribute for the `NewCodeBlock` components. Some use `"O6 / O6N"` while others use `"Device"`. For better consistency, consider using the same value throughout the document.
- docs/common/orion-common/app-dev/artificial-intelligence/_qwen2vl-2b.mdx (113-113) There's an inconsistency in the image paths. In the download section, the image is saved to `./test.png`, but in the testing section, it references `./Qwen2-VL-2B-Instruct/test.png`. This could cause confusion when users follow the guide.
💡 To request another review, post a new comment with "/windsurf-review".
docs/common/orion-common/app-dev/artificial-intelligence/_mobilenet-v2.mdx
Outdated
Show resolved
Hide resolved
docs/common/orion-common/app-dev/artificial-intelligence/_env-setup.mdx
Outdated
Show resolved
Hide resolved
docs/common/orion-common/app-dev/artificial-intelligence/_qwen2vl-2b.mdx
Show resolved
Hide resolved
|
/windsurf-review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Other comments (21)
- docs/common/orion-common/app-dev/artificial-intelligence/_qwen2vl-2b.mdx (58-58) The instructions reference a `requirements.txt` file, but don't specify where this file should come from or what dependencies it should contain. Consider adding information about the required dependencies or how to obtain the correct requirements file.
-
docs/common/orion-common/app-dev/artificial-intelligence/_API-manual.mdx (3-3)
The link text '此' (this) is not descriptive enough for accessibility purposes. Consider using more descriptive link text that indicates what the link points to.
详细的 API 手册可在[芯开发者中心 (CIX Developer Center)](https://developer.cixtech.com/)下载。 -
docs/common/orion-common/app-dev/artificial-intelligence/_pp-ocr-v4.mdx (21-21)
Missing `wget` command at the beginning of this line, which would cause the download to fail.
wget https://www.modelscope.cn/models/cix/ai_model_hub_25_Q3/resolve/master/models/ComputeVision/OCR/onnx_PP_OCRv4/cls.cix -
docs/common/orion-common/app-dev/artificial-intelligence/_pp-ocr-v4.mdx (51-51)
Missing `wget` command at the beginning of this line, which would cause the download to fail.
wget https://www.modelscope.cn/models/cix/ai_model_hub_25_Q3/resolve/master/models/ComputeVision/OCR/onnx_PP_OCRv4/model/PP-OCRv4_det.onnx -
docs/common/orion-common/app-dev/artificial-intelligence/_deeplab-v3.mdx (72-73)
The `cd ..` command is ambiguous. To avoid confusion, consider specifying the exact directory the user should be in before running the cixbuild command:
# Navigate back to the main model directory cd .. # Run the build configuration cixbuild cfg/onnx_deeplab_v3_build.cfg - docs/common/orion-common/app-dev/artificial-intelligence/_whisper-medium.mdx (170-170) The example output contains a future date (2025-12-29). Consider updating this to a realistic date to avoid confusion.
- docs/common/orion-common/app-dev/artificial-intelligence/_qwen2-5-vl-3b.mdx (59-59) The document references installing dependencies with `pip3 install -r requirements.txt`, but it doesn't specify where this requirements.txt file comes from or what it contains. Consider adding information about the source of this file or listing the key dependencies needed.
-
docs/common/orion-common/app-dev/artificial-intelligence/_deeplab-v3.mdx (35-35)
The quick start section's inference command is missing the required parameters. Consider updating it to match the complete example shown later:
python3 inference_npu.py --image_path test_data --model_path deeplab_v3.cix - docs/common/orion-common/app-dev/artificial-intelligence/_whisper-medium.mdx (135-135) The documentation states that both PC inference and NPU inference generate a file named 'test_audio_npu.txt'. Consider clarifying if these are different files or if the PC inference should generate a file with a different name (e.g., 'test_audio_onnx.txt').
- docs/common/ai/_ernie-4_5-0_3b_llama_cpp.mdx (174-174) This link should likely be updated to an absolute path like the one on line 55 was updated to `../../orion/o6/app-development/artificial-intelligence/llama_cpp.md` for consistency.
- docs/common/orion-common/app-dev/artificial-intelligence/_resnet50.mdx (38-38) Consider adding expected output for the quick start section to help users verify their setup is working correctly.
- docs/common/orion-common/app-dev/artificial-intelligence/_vdsr.mdx (120-129) The NPU inference output example is missing the PSNR metrics that were present in the original documentation. Consider adding back the PSNR comparison values (e.g., `PSNR_bicubic= 20.77...` and `PSNR_predicted= 25.37...`) to demonstrate the quantitative improvement the model provides over bicubic interpolation.
- docs/common/orion-common/app-dev/artificial-intelligence/_API-manual.mdx (5-5) The instructions for finding the documentation could be more specific to help users locate the resources more easily. Consider providing more detailed steps or a direct link if possible.
- docs/common/orion-common/app-dev/artificial-intelligence/_qwen2-5-vl-3b.mdx (43-43) There's an inconsistency in the tip attributes for NewCodeBlock components. Some use tip="Device" while others use tip="O6 / O6N", but they all have type="device". For consistency, these should be standardized to use the same tip value throughout the document.
- docs/common/orion-common/app-dev/artificial-intelligence/_whisper-medium.mdx (20-20) There's a typo in the directory path throughout the document. 'Speech_Recognotion' should be 'Speech_Recognition'.
-
docs/common/orion-common/app-dev/artificial-intelligence/_yolov8s-pose.mdx (6-11)
The closing tag for the info block is indented, which may cause rendering issues. Consider aligning it with the opening tag.
:::info[环境配置] 需要提前配置好相关环境。 - [环境配置](../../../../orion/o6/app-development/artificial-intelligence/env-setup.md) - [AI Model Hub](../../../../orion/o6/app-development/artificial-intelligence/ai-hub.md) ::: -
docs/common/orion-common/app-dev/artificial-intelligence/_ultra-fast-lane-detection-v2.mdx (72-72)
There appears to be a typo in the model conversion command. The filename format is inconsistent with the naming convention used elsewhere in the document.
cixbuild cfg/Ultra_Fast_Lane_Detection_v2build.cfg -
docs/common/orion-common/app-dev/artificial-intelligence/_ultra-fast-lane-detection-v2.mdx (11-11)
The closing tag for the info box has incorrect formatting with extra spaces.
::: -
docs/common/orion-common/app-dev/artificial-intelligence/_scrfd-arcface.mdx (9-11)
The closing tag for the info box has incorrect indentation which may cause rendering issues.
- [环境配置](../../../../orion/o6/app-development/artificial-intelligence/env-setup.md) - [AI Model Hub](../../../../orion/o6/app-development/artificial-intelligence/ai-hub.md) ::: - docs/common/orion-common/app-dev/artificial-intelligence/_qwen2vl-2b.mdx (42-42) There's an inconsistency in the tip labels for NewCodeBlock components. Some use 'O6 / O6N' while others use 'Device'. For better consistency, consider standardizing all tip labels to 'O6 / O6N' since this appears to be device-specific documentation.
- docs/common/orion-common/app-dev/artificial-intelligence/_qwen2vl-2b.mdx (121-122) The command output shown has a line break in the middle of a command path, which might confuse readers. Consider reformatting this output for better readability or adding a note that this is just how the output appears.
💡 To request another review, post a new comment with "/windsurf-review".
docs/common/orion-common/app-dev/artificial-intelligence/_qwen2-5-vl-3b.mdx
Show resolved
Hide resolved
docs/common/orion-common/app-dev/artificial-intelligence/_qwen2-5-vl-3b.mdx
Show resolved
Hide resolved
docs/common/orion-common/app-dev/artificial-intelligence/_whisper-medium.mdx
Show resolved
Hide resolved
|
/windsurf-review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Other comments (9)
- docs/common/orion-common/app-dev/artificial-intelligence/_real-esrgan.mdx (28-30) The documentation mentions 'Running before activating virtual environment!' but doesn't provide instructions on how to activate the virtual environment. Consider adding a command example for activating the virtual environment or linking to relevant documentation.
- docs/common/ai/_llama_cpp.mdx (50-50) For consistency and optimal build performance, consider adding the `-j$(nproc)` flag to all the build commands. This flag is present in the first build example but missing in the subsequent ones.
-
docs/common/orion-common/app-dev/artificial-intelligence/_API-manual.mdx (3-3)
Consider using more descriptive link text instead of 'this'. For better accessibility and user experience, the link text should describe its destination.
详细的 API 手册可在[芯开发者中心](https://developer.cixtech.com/)下载。 - docs/common/orion-common/app-dev/artificial-intelligence/_whisper-medium.mdx (20-20) There's a typo in the directory path - 'Speech_Recognotion' should be 'Speech_Recognition'.
- docs/common/orion-common/app-dev/artificial-intelligence/_whisper-medium.mdx (59-59) The same 'Speech_Recognotion' typo appears here as well.
- docs/common/orion-common/app-dev/artificial-intelligence/_real-esrgan.mdx (111-112) There's an inconsistency between the command shown for running the inference script (`python3 inference_npu.py`) and the command shown in the output example (`$ python inference_npu.py`). Consider making these consistent to avoid confusion.
-
docs/common/orion-common/app-dev/artificial-intelligence/_scrfd-arcface.mdx (9-11)
The closing tag for the info box has incorrect indentation which may cause rendering issues.
- [环境配置](../../../../orion/o6/app-development/artificial-intelligence/env-setup.md) - [AI Model Hub](../../../../orion/o6/app-development/artificial-intelligence/ai-hub.md) ::: - docs/common/ai/_ernie-4_5-0_3b_llama_cpp.mdx (55-55) There's an inconsistency in the capitalization of 'llama.cpp'. The text uses lowercase 'llama.cpp' but the link text still uses uppercase 'Llama.cpp'. Consider updating the link text to match the lowercase style used throughout the document.
- docs/common/ai/_ernie-4_5-0_3b_llama_cpp.mdx (174-174) There's an inconsistency in the capitalization of 'llama.cpp'. The text uses lowercase 'llama.cpp' but the link text still uses uppercase 'Llama.cpp'. Consider updating the link text to match the lowercase style used throughout the document.
💡 To request another review, post a new comment with "/windsurf-review".
docs/common/orion-common/app-dev/artificial-intelligence/_pp-ocr-v4.mdx
Outdated
Show resolved
Hide resolved
docs/common/orion-common/app-dev/artificial-intelligence/_whisper-medium.mdx
Show resolved
Hide resolved
docs/common/orion-common/app-dev/artificial-intelligence/_whisper-medium.mdx
Show resolved
Hide resolved
|
/windsurf-review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Other comments (11)
-
docs/common/orion-common/app-dev/artificial-intelligence/_API-manual.mdx (3-3)
Consider using more descriptive link text instead of 'this'. For better accessibility and user experience, the link text should describe the destination.
详细的 API 手册可在[芯开发者中心](https://developer.cixtech.com/)下载。 - docs/common/orion-common/app-dev/artificial-intelligence/_qwen2vl-2b.mdx (58-58) The command `pip3 install -r requirements.txt` references a requirements.txt file, but it's not specified where this file comes from. Consider clarifying if this file is in the llama.cpp repository or if users need to create it with specific dependencies.
- docs/common/orion-common/app-dev/artificial-intelligence/_qwen2vl-2b.mdx (101-102) The image shown in the documentation (`/img/orion/o6/ai-models/sd-npu.webp`) doesn't match the test image described in the output (a rose on a marble surface). Consider using the actual test image in the documentation for consistency.
- docs/common/orion-common/app-dev/artificial-intelligence/_whisper-medium.mdx (47-47) The basic inference command doesn't include the model path parameters that are shown in the full example later. Consider updating the basic command to be consistent with the full example to avoid confusion.
- docs/common/orion-common/app-dev/artificial-intelligence/_ultra-fast-lane-detection-v2.mdx (112-112) The document shows running `inference_npu.py` twice - once in the quick start section (line 35) and again in the complete workflow section (line 112). Consider clarifying the difference between these two runs or removing the redundancy to avoid confusion about the proper sequence of steps.
- docs/common/orion-common/app-dev/artificial-intelligence/_API-manual.mdx (5-5) The instructions for finding the documentation could be more specific. Consider providing clearer steps on how to navigate to the AI section after reaching the developer center.
-
docs/common/orion-common/app-dev/artificial-intelligence/_scrfd-arcface.mdx (9-11)
The closing tag for the info box has incorrect indentation which may cause rendering issues.
- [环境配置](../../../../orion/o6/app-development/artificial-intelligence/env-setup.md) - [AI Model Hub](../../../../orion/o6/app-development/artificial-intelligence/ai-hub.md) ::: - docs/common/orion-common/app-dev/artificial-intelligence/_pp-ocr-v4.mdx (229-229) There's a character encoding issue in the NPU output results. The text '【适用人君】' should be '【适用人群】' (the character '君' should be '群'). This could confuse readers comparing host vs NPU results.
- docs/common/orion-common/app-dev/artificial-intelligence/_pp-ocr-v4.mdx (235-235) There's a transcription error in the NPU output results. The text '发定够的滋养' should be '发足够的滋养' (the character '定' should be '足'). This inconsistency between host and NPU outputs might confuse readers about model accuracy.
- docs/common/orion-common/app-dev/artificial-intelligence/_pp-ocr-v4.mdx (232-232) There's a transcription error in the NPU output results. The text '(成品色材)' should be '(成品包材)' (the characters '色材' should be '包材'). This inconsistency between host and NPU outputs might confuse readers about model accuracy.
- docs/common/orion-common/app-dev/artificial-intelligence/_whisper-medium.mdx (169-169) The example output shows a future date (2025-12-29). This should be updated to a realistic date to avoid confusion.
💡 To request another review, post a new comment with "/windsurf-review".
docs/common/orion-common/app-dev/artificial-intelligence/_qwen2vl-2b.mdx
Show resolved
Hide resolved
docs/common/orion-common/app-dev/artificial-intelligence/_whisper-medium.mdx
Show resolved
Hide resolved
docs/common/orion-common/app-dev/artificial-intelligence/_ultra-fast-lane-detection-v2.mdx
Show resolved
Hide resolved
|
All done. |
Signed-off-by: Ronin <dengluoning@radxa.com>
Description of changes
docs: rewrite O6/O6N docs.