Skip to content

Conversation

@zifeng-radxa
Copy link
Contributor

docs: upgrade dx-m1 sdk to v2.1.0

@zifeng-radxa zifeng-radxa requested review from a team, akgnah and xzuoqi as code owners December 26, 2025 09:19
Copy link
Contributor

@windsurf-bot windsurf-bot bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other comments (1)
  • docs/aicore/dx-m1/dx-sdk/dx-app.md (83-83) There appears to be an error in the setup script that hasn't been fixed in the new version: `./scripts/run_classifier.sh: line 28: [: check_valid_dir_or_symlink: unary operator expected`. Consider addressing this shell script error in the documentation or fixing the underlying script.

💡 To request another review, post a new comment with "/windsurf-review".


</NewCodeBlock>

构建完成后会在当前目录下生成 `DEEPX_DX-COM_UM_v2.1.0_Nov_2025.pdf`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The generated PDF filename DEEPX_DX-COM_UM_v2.1.0_Nov_2025.pdf references November 2025, which is a future date. This appears to be a typo and should likely be corrected to the current year.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this filename is correct


### 编译 DX-STREAM

进入 `dx-all-suite/dx-runtime/dx_rt` 目录
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a mismatch in the directory path. The instruction mentions entering dx-all-suite/dx-runtime/dx_rt directory, but the actual command uses dx-all-suite/dx-runtime/dx_stream.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

Comment on lines 141 to 144
```bash
sudo depmod -A
sudo cp modules/dx_dma.conf /etc/modprobe.d/
```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the Makefile compilation section, the command to copy dx_dma.conf is missing the path to the file. It should be sudo cp modules/dx_dma.conf /etc/modprobe.d/ to be consistent with the path shown in the script compilation section.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this command is correct

@zifeng-radxa
Copy link
Contributor Author

/windsurf-review

Copy link
Contributor

@windsurf-bot windsurf-bot bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other comments (1)
  • docs/aicore/dx-m1/dx-sdk/dx-com.md (487-487) The generated PDF filename `DEEPX_DX-COM_UM_v2.1.0_Nov_2025.pdf` references November 2025, which is a future date. This appears to be a placeholder or typo that should be updated to the current year.

💡 To request another review, post a new comment with "/windsurf-review".

Comment on lines +80 to +81
rock@rock-5b-plus:/mnt/ssd/deepx/v2.1.0/dx_app$ ./scripts/run_classifier.sh
/mnt/ssd/deepx/v2.1.0/dx_app /mnt/ssd/deepx/v2.1.0/dx_app
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The PR title mentions upgrading to v2.1.0, but the changes show replacing references from v2.9.5 to v2.1.0. Is this actually a downgrade rather than an upgrade? If v2.1.0 is indeed newer than v2.9.5, it might be worth clarifying the version numbering scheme in the documentation to avoid confusion.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

v2.1.0 is the latest version, v2.9.5 is old version name, for now the named v2.1.0

rock@rock-5b-plus:/mnt/ssd/deepx/v2.1.0/dx_app$ ./scripts/run_classifier.sh
/mnt/ssd/deepx/v2.1.0/dx_app /mnt/ssd/deepx/v2.1.0/dx_app
[INFO] DX_APP_PATH: /mnt/ssd/deepx/v2.1.0/dx_app
./scripts/run_classifier.sh: line 28: [: check_valid_dir_or_symlink: unary operator expected
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The error message ./scripts/run_classifier.sh: line 28: [: check_valid_dir_or_symlink: unary operator expected appears in both the old and new versions. Consider fixing this script error in the SDK or adding a note explaining that this error is expected and can be ignored.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it doesn't matter

<NewCodeBlock tip="Host" type="device">
```bash
export DXRT_DYNAMIC_CPU_THREAD=ON
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The new version adds export DXRT_DYNAMIC_CPU_THREAD=ON before running the detector script. Consider adding a brief explanation of what this environment variable does and why it's needed.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it doesn't matter

@zifeng-radxa
Copy link
Contributor Author

/windsurf-review

Copy link
Contributor

@windsurf-bot windsurf-bot bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 To request another review, post a new comment with "/windsurf-review".


</NewCodeBlock>

构建完成后会在当前目录下生成 `DEEPX_DX-COM_UM_v2.1.0_Nov_2025.pdf`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The generated PDF filename includes Nov_2025 which appears to be a future date. This might be a typo or placeholder that should be updated to the current year.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it is correct


</NewCodeBlock>

构建完成后会在 `output_web` 生成 `dx-modelzoo_v0.1.0.pdf`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The document mentions generating a PDF file named dx-modelzoo_v0.1.0.pdf (line 126), but the PR is upgrading to SDK v2.1.0. Should the PDF version number be updated to match the SDK version for consistency?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it is correct

rock@rock-5b-plus:/mnt/ssd/deepx/v2.1.0/dx_app$ ./scripts/run_classifier.sh
/mnt/ssd/deepx/v2.1.0/dx_app /mnt/ssd/deepx/v2.1.0/dx_app
[INFO] DX_APP_PATH: /mnt/ssd/deepx/v2.1.0/dx_app
./scripts/run_classifier.sh: line 28: [: check_valid_dir_or_symlink: unary operator expected
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Both the old and new versions show the same error message: ./scripts/run_classifier.sh: line 28: [: check_valid_dir_or_symlink: unary operator expected. Consider fixing this script issue in the SDK or adding a note explaining that this error can be safely ignored.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it doesn't matter

@zifeng-radxa
Copy link
Contributor Author

/windsurf-review

Copy link
Contributor

@windsurf-bot windsurf-bot bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other comments (6)
  • docs/aicore/dx-m1/dx-sdk/dx-rt.md (69-73) The help text for the `--python_version` option is missing specific version numbers. There are two blank spots where version information should be provided:
      --python_version <VERSION>   Specify the Python version to install (e.g., 3.10.4).
                                     * Minimum supported version: 3.8.
                                     * If not specified:
                                         - For Ubuntu 20.04+, the OS default Python 3 will be used.
                                         - For Ubuntu 18.04, Python 3.8 will be source-built.
    
  • docs/aicore/dx-m1/dx-sdk/dx-rt.md (588-588) The documentation mentions generating a PDF with an incorrect name. It should be DX-RT instead of DX-APP since this is the DX-RT documentation:
    构建完成后会在当前目录下生成 `DEEPX_DX-RT_UM_v2.1.0.pdf`
    
  • docs/aicore/dx-m1/dx-sdk/dx-app.md (83-83) There's an error message in the command output: `./scripts/run_classifier.sh: line 28: [: check_valid_dir_or_symlink: unary operator expected`. This might confuse users following the documentation. Consider fixing the script or adding a note explaining that this error can be safely ignored.
  • docs/aicore/dx-m1/dx-sdk/dx-model-zoo.md (41-41) The installation script has changed from `setup.sh` to `install.sh`. Consider adding a note about this change for users upgrading from previous versions, including whether the old script is still available or if any migration steps are needed.
  • docs/aicore/dx-m1/dx-sdk/dx-com.md (487-487) The generated PDF filename `DEEPX_DX-COM_UM_v2.1.0_Nov_2025.pdf` references November 2025, which is a future date. This appears to be a typo and should likely be corrected to the current year.
  • docs/aicore/dx-m1/dx-sdk/dx-rt.md (153-153) The `-v`, `--version` option is missing a closing quote which could cause formatting issues:
    | `-v`, `--version`                    | 打印所需驱动,固件,模型编译器最小版本信息                                                                  |
    

💡 To request another review, post a new comment with "/windsurf-review".

Comment on lines 142 to 143
sudo depmod -A
sudo cp modules/dx_dma.conf /etc/modprobe.d/
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The path to dx_dma.conf is incorrect. Since the user is already in the 'modules' directory (as shown in the cd command at the beginning of the installation section), the correct path should be just 'dx_dma.conf' instead of 'modules/dx_dma.conf'.

Suggested change
sudo depmod -A
sudo cp modules/dx_dma.conf /etc/modprobe.d/
sudo depmod -A
sudo cp dx_dma.conf /etc/modprobe.d/

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

done

<NewCodeBlock tip="Host" type="device">

```bash
sudo ./build.sh -d m1 -m deepx -c install
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The script compilation section is missing the initial compilation step before installation. For consistency with the original documentation and proper procedure, please include both steps:

Suggested change
sudo ./build.sh -d m1 -m deepx -c install
./build.sh -d m1 -m deepx
sudo ./build.sh -d m1 -m deepx -c install

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this command is correct

sudo make DEVICE=m1 PCIE=deepx install
```
```bash
sudo make DEVICE=m1 PCIE=deepx install
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The Makefile compilation section is missing the initial compilation step before installation. For consistency with the original documentation and proper procedure, please include both steps:

Suggested change
sudo make DEVICE=m1 PCIE=deepx install
make DEVICE=m1 PCIE=deepx
sudo make DEVICE=m1 PCIE=deepx install

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this command is correct

@zifeng-radxa
Copy link
Contributor Author

/windsurf-review

Copy link
Contributor

@windsurf-bot windsurf-bot bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other comments (1)
  • docs/aicore/dx-m1/dx-sdk/dx-rt.md (153-153) The `--version` option is missing a closing backtick which breaks the markdown formatting.
    | `-v`, `--version`                    | 打印所需驱动,固件,模型编译器最小版本信息                                                                  |
    

💡 To request another review, post a new comment with "/windsurf-review".

Comment on lines +70 to +73
* Minimum supported version: .
* If not specified:
- For Ubuntu 20.04+, the OS default Python 3 will be used.
- For Ubuntu 18.04, Python will be source-built.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The help text for the --python_version option is missing the minimum supported version information. The text shows * Minimum supported version: . and later Python will be source-built without specifying versions.


</NewCodeBlock>

构建完成后会在当前目录下生成 `DEEPX_DX-COM_UM_v2.1.0_Nov_2025.pdf`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The generated PDF filename shows a future date: DEEPX_DX-COM_UM_v2.1.0_Nov_2025.pdf. This appears to be incorrect as it references the year 2025. Please update this to the current year or remove the specific date if it's meant to be a placeholder.

rock@rock-5b-plus:/mnt/ssd/deepx/v2.1.0/dx_app$ ./scripts/run_classifier.sh
/mnt/ssd/deepx/v2.1.0/dx_app /mnt/ssd/deepx/v2.1.0/dx_app
[INFO] DX_APP_PATH: /mnt/ssd/deepx/v2.1.0/dx_app
./scripts/run_classifier.sh: line 28: [: check_valid_dir_or_symlink: unary operator expected
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The error message ./scripts/run_classifier.sh: line 28: [: check_valid_dir_or_symlink: unary operator expected appears in both the old and new versions. This suggests there might be a bug in the script that hasn't been addressed in this update.

Signed-off-by: ZIFENG278 <zifengzhang18@gmail.com>
@jack-ma jack-ma merged commit 4466ab9 into radxa-docs:main Dec 26, 2025
5 of 6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants