docs: update AX-M1 docs of ai models #1204
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Ronin-1124
requested review from
zifeng-radxa
and removed request for
a team
![windsurf-bot[bot]](https://avatars.githubusercontent.com/in/1066231?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Other comments (11)
-
docs/aicore/ax-m1/vision-models/yolov8s.md (30-31)
There's a potential issue with the Hugging Face installation command. You're installing `huggingface_hub` but using the `hf` command. For consistency, you should either:
- Install with the CLI extra:
pip3 install -U "huggingface_hub[cli]"to ensure the CLI commands are available, or - Use the full command:
python -m huggingface_hub downloadinstead ofhf download
The current approach might lead to the
hfcommand not being available after installation. - Install with the CLI extra:
-
docs/aicore/ax-m1/LLM/smolLM2-360m.md (27-27)
There's a typo in the download command. The `--local-dir` parameter has `cd` incorrectly appended to the directory name.
hf download AXERA-TECH/SmolLM2-360M-Instruct --local-dir ./SmolLM2-360M-Instruct - docs/aicore/ax-m1/LLM/smolLM2-360m.md (60-60) The example output shows running `smollm2_tokenizer.py` but the command above uses `smollm2_tokenizer_uid.py`. This inconsistency might confuse users. Either update the example output or ensure both scripts work the same way.
- docs/aicore/ax-m1/LLM/ds-r1-qwen-7b.md (26-27) The installation command has been updated to use `hf download` instead of `huggingface-cli download`, but the package being installed is now just `huggingface_hub` without the `[cli]` extra. Please verify that the `hf` command is available with this installation or update to `pip3 install -U "huggingface_hub[cli]"` to ensure the CLI functionality is included.
-
docs/aicore/ax-m1/LLM/ds-r1-qwen-7b.md (28-28)
The directory name in the `cd` command doesn't match the download directory. The download uses `./DeepSeek-R1-Distill-Qwen-7B-GPTQ-Int4` but the `cd` command uses `DeepSeek-R1-Distill-Qwen-7B`. Please update to use the correct directory name:
cd DeepSeek-R1-Distill-Qwen-7B-GPTQ-Int4 -
docs/aicore/ax-m1/text-to-image/sd15.md (24-24)
The installation command for huggingface_hub doesn't include the [cli] extra that's needed for the 'hf' command to work. Consider updating the installation command to:
pip3 install -U "huggingface_hub[cli]" -
docs/aicore/ax-m1/LLM/minicpm4-0.5b.md (26-26)
The updated command uses `hf download` but the pip install command doesn't include the CLI component. Consider changing the pip install command to include the CLI:
pip3 install -U "huggingface_hub[cli]" -
docs/aicore/ax-m1/LLM/qwen3-1.7b.md (26-27)
The updated command uses `hf download` but the installation package is just `huggingface_hub` without the `[cli]` component. This might cause the `hf` command to be unavailable. Consider keeping the `[cli]` component in the installation command:
pip3 install -U "huggingface_hub[cli]" hf download AXERA-TECH/Qwen3-1.7B --local-dir ./Qwen3-1.7B - docs/aicore/ax-m1/vision-models/liveportrait.md (27-27) The command to download from Hugging Face has changed from `huggingface-cli download` to `hf download`. Consider adding a note explaining this change for users who might be familiar with the older command.
- docs/aicore/ax-m1/axcl-samples.md (78-78) The `axcl_yolov8_seg` binary is shown in the compilation output but is missing from the model demo links section. Consider adding it to maintain consistency.
- docs/aicore/ax-m1/vision-models/liveportrait.md (26-26) There's an inconsistency in the pip commands used throughout the document. Line 26 uses `pip install` while line 49 uses `pip3 install`. For consistency, it would be better to use either `pip` or `pip3` throughout the entire document.
💡 To request another review, post a new comment with "/windsurf-review".
Contributor
Author
|
/windsurf-review |
Contributor
There was a problem hiding this comment.
Other comments (13)
- docs/aicore/ax-m1/LLM/smolLM2-360m.md (50-50) The script name in the command (`smollm2_tokenizer_uid.py`) doesn't match the script name shown in the output example below (`smollm2_tokenizer.py`). This inconsistency could confuse users.
-
docs/aicore/ax-m1/vision-models/yolov8s.md (30-31)
There's an inconsistency between the installed package and the command used. The code installs `huggingface_hub` but should include the CLI extras since you're using the command line interface:
pip3 install -U "huggingface_hub[cli]" hf download AXERA-TECH/YOLOv8 --local-dir ./YOLOv8Alternatively, if you're intentionally using the newer
hfcommand, please update the documentation to explain this change. -
docs/aicore/ax-m1/text-to-image/sd15.md (24-24)
The installation command for huggingface_hub doesn't include the [cli] extra, but the command on the next line uses 'hf' which requires the CLI functionality. Consider updating to:
pip3 install -U "huggingface_hub[cli]" -
docs/aicore/ax-m1/LLM/ds-r1-qwen-7b.md (27-28)
The directory name in the `cd` command doesn't match the download directory. It should be `cd DeepSeek-R1-Distill-Qwen-7B-GPTQ-Int4` instead of `cd DeepSeek-R1-Distill-Qwen-7B`.
hf download AXERA-TECH/DeepSeek-R1-Distill-Qwen-7B-GPTQ-Int4 --local-dir ./DeepSeek-R1-Distill-Qwen-7B-GPTQ-Int4 cd DeepSeek-R1-Distill-Qwen-7B-GPTQ-Int4 -
docs/aicore/ax-m1/LLM/minicpm4-0.5b.md (26-27)
The installation command and download command are inconsistent. If using `hf download`, the installation should be updated to match:
pip3 install -U huggingface_hubOr if you want to keep the CLI functionality, use:
pip3 install -U "huggingface_hub[cli]" hf download AXERA-TECH/MiniCPM4-0.5B --local-dir ./MiniCPM4-0.5B - docs/aicore/ax-m1/VLM/internvl3-2b.md (26-27) The command `hf download` may not work directly after installing just the `huggingface_hub` package. You should either install with `pip install -U "huggingface_hub[cli]"` to get the CLI tools or use `huggingface-cli download` instead of `hf download`.
- docs/aicore/ax-m1/LLM/qwen3-1.7b.md (26-27) The installation command and usage don't seem to match. You're installing `huggingface_hub` but using an `hf` command. Should this be `huggingface-cli` instead, or does the base package provide the `hf` command without needing the `[cli]` extra?
- docs/aicore/ax-m1/VLM/qwen2.5-vl-3b.md (26-27) The installation command has been changed from `huggingface_hub[cli]` to just `huggingface_hub`, and the download command from `huggingface-cli download` to `hf download`. Please verify that the `hf` command is available with the basic installation without the `[cli]` extra.
-
docs/aicore/ax-m1/axcl-samples.md (78-78)
The link for `axcl_yolov8_pose` incorrectly points to `yolov8-seg.md`. It should likely point to `yolov8-pose.md` instead.
- **YOLOv8:** [axcl_yolov8](./vision-models/yolov8s.md) · [axcl_yolov8_pose](./vision-models/yolov8-pose.md) -
docs/aicore/ax-m1/vision-models/depth-anything-v2.md (26-26)
The installation command for huggingface_hub is missing the CLI component, but the download command uses 'hf' which requires it. Consider updating the installation command to:
pip3 install -U "huggingface_hub[cli]" - docs/aicore/ax-m1/axcl-samples.md (78-78) The `axcl_yolov8_seg` binary is listed in the tree output but not included in the links section. Consider adding a link to the corresponding documentation page.
- docs/aicore/ax-m1/LLM/qwen3-1.7b.md (56-57) The explanation for `%N` is inconsistent between the warning and the text. Consider standardizing to something like: `%N` is the corresponding background job number from the `jobs` command.
-
docs/aicore/ax-m1/axcl-samples.md (13-13)
There's a typo in the Chinese text where '根据根据' (according to according to) is repeated. Consider removing one instance for better readability.
您需要根据 [**环境安装**](./getting-started/env_install.md) 配置好 AXCL 驱动.
💡 To request another review, post a new comment with "/windsurf-review".
Contributor
Author
|
/windsurf-review |
Contributor
There was a problem hiding this comment.
Other comments (4)
- docs/aicore/ax-m1/LLM/smolLM2-360m.md (50-60) There's an inconsistency between the script name in the command (`smollm2_tokenizer_uid.py`) and the script name shown in the example output (`smollm2_tokenizer.py`). These should be consistent to avoid confusion.
- docs/aicore/ax-m1/LLM/minicpm4-0.5b.md (26-27) The installation command has been updated to `pip3 install -U "huggingface_hub"` but the download command now uses `hf download`. To ensure this works correctly, you might need to keep the [cli] extension in the installation command: `pip3 install -U "huggingface_hub[cli]"` or verify that the base package includes the CLI functionality.
- docs/aicore/ax-m1/text-to-image/sd15.md (24-25) The installation command and the download command are inconsistent. You're installing `huggingface_hub` but the [cli] suffix has been removed. This is correct for using the `hf` command, but you might want to add a comment explaining the change from the previous `huggingface-cli` command to the new `hf` command for users who might be familiar with the old documentation.
- docs/aicore/ax-m1/LLM/smolLM2-360m.md (83-83) The build time in the example output shows a future date (Feb 13 2025). This should be updated to reflect a realistic build date.
💡 To request another review, post a new comment with "/windsurf-review".
Contributor
There was a problem hiding this comment.
Other comments (11)
-
docs/common/ai/_cubie_acuity_env.mdx (154-154)
Same issue with non-standard hyphens in this command.
sudo docker exec -it 容器ID /bin/bash -
docs/common/ai/_cubie_acuity_env.mdx (81-81)
The docker image name contains a non-standard Unicode hyphen (`‑`) which may cause issues when users try to reference it.
当 docker 镜像载入完成后可以在 `docker images` 中看到此镜像， 名字为 `ubuntu-npu:v2.0.10` -
docs/aicore/ax-m1/vision-models/depth-anything-v2.md (26-26)
The installation command for huggingface_hub is missing the CLI component, but the download command uses 'hf download' which requires it. Please update the installation command to include the CLI component:
pip3 install -U "huggingface_hub[cli]" -
docs/aicore/ax-m1/VLM/qwen2.5-vl-3b.md (25-27)
The command for downloading from Hugging Face is incorrect. When installing `huggingface_hub`, the command-line tool is named `huggingface-cli`, not `hf`.
pip3 install -U "huggingface_hub[cli]" huggingface-cli download AXERA-TECH/Qwen2.5-VL-3B-Instruct --local-dir ./Qwen2.5-VL-3B-Instruct - docs/aicore/ax-m1/VLM/qwen2.5-vl-3b.md (60-60) There's an inconsistency between the script name in the command and the output example. Either update the command or update the example output to use the same script name.
- docs/aicore/ax-m1/LLM/qwen2.5-1.5b.md (30-30) The command `hf download` requires the CLI functionality, but the installation command only installs the base package. Consider updating to `pip3 install -U "huggingface_hub[cli]"` to ensure the CLI commands are available.
- docs/aicore/ax-m1/LLM/minicpm4-0.5b.md (26-26) The installation command `pip3 install -U "huggingface_hub"` may not provide the `hf` command used in the next line. To ensure the CLI tools are available, you should install with `pip3 install -U "huggingface_hub[cli]"` instead.
- docs/aicore/ax-m1/LLM/smolLM2-360m.md (50-60) There's an inconsistency between the script name in the command (`smollm2_tokenizer_uid.py`) and the script name shown in the example output (`smollm2_tokenizer.py`). These should be consistent to avoid confusion.
- docs/aicore/ax-m1/Audio/whisper.md (24-25) The command has been updated from `huggingface-cli download` to `hf download`. It would be helpful to add a note explaining that `hf` is the new command-line interface for Hugging Face, or to provide installation instructions if `hf` requires separate installation.
- docs/aicore/ax-m1/vision-models/yolov11.md (30-31) The installation command only installs 'huggingface_hub' but then uses 'hf download' command. Consider either installing the CLI component with `pip3 install -U "huggingface_hub[cli]"` or updating the download command to use the appropriate Python API method.
-
docs/aicore/ax-m1/VLM/yolo-world-v2.md (24-24)
The installation command should match the command being used. Since you're using `hf download` instead of `huggingface-cli download`, the installation should be updated to match.
pip3 install -U huggingface_hub
💡 To request another review, post a new comment with "/windsurf-review".
Contributor
Author
|
/windsurf-review |
Contributor
There was a problem hiding this comment.
Other comments (9)
- docs/common/ai/_cubie_acuity_env.mdx (81-81) The image name contains en dashes (`ubuntu‑npu:v2.0.10`) instead of regular hyphens. This should be corrected to `ubuntu-npu:v2.0.10` for consistency with the docker load command and to avoid confusion.
- docs/aicore/ax-m1/LLM/minicpm4-0.5b.md (26-27) The installation command has been updated to use `hf download` instead of `huggingface-cli download`, but the package installation command has been changed from `pip3 install -U "huggingface_hub[cli]"` to `pip3 install -U "huggingface_hub"`. The CLI functionality might require the [cli] extension. Please verify that `hf download` works with just the base package.
- docs/aicore/ax-m1/text-to-image/sd15.md (25-25) The command `hf download` appears to be incorrect. When installing the huggingface_hub package, the CLI command should be `huggingface-cli download`. Please verify this command works with the current version of huggingface_hub or update to the correct CLI command.
-
docs/aicore/ax-m1/vision-models/yolov8s.md (30-30)
The installation command and download command should use consistent package references. Since you're using `hf download` (new format), the installation should be just `huggingface_hub` without the `[cli]` suffix.
pip3 install -U "huggingface_hub" - docs/aicore/ax-m1/LLM/qwen3-1.7b.md (26-26) The installation command `pip3 install -U "huggingface_hub"` may not provide the `hf` command line tool. To ensure the `hf download` command works, you should install the CLI component with: `pip3 install -U "huggingface_hub[cli]"` instead.
-
docs/aicore/ax-m1/VLM/yolo-world-v2.md (24-25)
The command `hf download` appears to be incorrect. When installing `huggingface_hub`, the correct CLI command is `huggingface-cli download`. Please verify this command works or update to the correct syntax.
pip3 install -U "huggingface_hub[cli]" huggingface-cli download AXERA-TECH/YOLO-World-V2 --local-dir ./YOLO-World-V2 - docs/aicore/ax-m1/LLM/smolLM2-360m.md (60-60) There's an inconsistency between the script name in the command (`smollm2_tokenizer_uid.py`) and the one shown in the example output (`smollm2_tokenizer.py`). These should be consistent to avoid confusion for users.
- docs/aicore/ax-m1/LLM/smolLM2-360m.md (83-83) The build time in the example output shows 'Feb 13 2025', which is a future date. This should be updated to reflect an accurate build time.
- docs/aicore/ax-m1/vision-models/liveportrait.md (26-27) There's an inconsistency in the pip command usage. For consistency, either use `pip install` or `pip3 install` throughout the documentation, not both.
💡 To request another review, post a new comment with "/windsurf-review".
Contributor
Author
|
/windsurf-review |
Contributor
There was a problem hiding this comment.
Other comments (7)
-
docs/aicore/ax-m1/LLM/minicpm4-0.5b.md (26-26)
The installation command for huggingface_hub is missing the CLI component, but the download command uses the CLI. Please update the installation command to include the CLI component:
pip3 install -U "huggingface_hub[cli]" - docs/aicore/ax-m1/LLM/minicpm4-0.5b.md (27-27) The download command has been changed to use `hf` instead of `huggingface-cli`, but this might not be consistent with the package being installed. If you're installing just `huggingface_hub` without the CLI component, the command should be `python -m huggingface_hub download`. If you're using the CLI component, the command should be `huggingface-cli download`.
-
docs/common/ai/_cubie_acuity_env.mdx (103-103)
There's an inconsistency in the docker exec command formatting between the A733 and T527 sections. In the A733 section, line 103 uses special em dashes (`‑`) while the T527 section on line 154 uses regular hyphens (`-`). This could cause copy-paste issues for users. Consider standardizing to regular hyphens in both sections.
sudo docker exec -it 容器ID /bin/bash - docs/aicore/ax-m1/LLM/ds-r1-qwen-7b.md (26-26) The command `hf download` is used, but the package installed is `huggingface_hub` without the [cli] extra. Consider updating to `pip3 install -U "huggingface_hub[cli]"` to ensure the CLI commands are available.
- docs/aicore/ax-m1/LLM/smolLM2-360m.md (60-60) The example output still shows `python3 smollm2_tokenizer.py` while the command has been updated to use `smollm2_tokenizer_uid.py`. This inconsistency should be fixed to avoid confusion.
-
docs/aicore/ax-m1/vision-models/depth-anything-v2.md (26-27)
The installation command `pip3 install -U "huggingface_hub"` should include the [cli] extra since you're using the command-line interface with `hf download`. Consider updating to:
pip3 install -U "huggingface_hub[cli]" hf download AXERA-TECH/Depth-Anything-V2 --local-dir ./Depth-Anything-V2 - docs/aicore/ax-m1/vision-models/liveportrait.md (26-26) There's an inconsistency in the pip commands. In one place you use `pip install` and in another `pip3 install`. For consistency, please use the same command throughout the document.
💡 To request another review, post a new comment with "/windsurf-review".
Signed-off-by: Ronin <dengluoning@radxa.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of changes
docs: update AX-M1 docs of ai models