AI/rocm-systems
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update help text in README (#1837)

Browse Source
This commit is contained in:
Atul Kulkarni
2025-08-01 14:19:27 -05:00
committed by GitHub
parent 5ecc1b7ede
commit e2c9f2feab
2 changed files with 10 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+9 -6
View File
@@ -34,31 +34,34 @@ For more info on build options/flags when using the install script, use `./insta
RCCL build & installation helper script RCCL build & installation helper script
Options: Options:
--address-sanitizer Build with address sanitizer enabled --address-sanitizer Build with address sanitizer enabled
-d|--dependencies Install RCCL depdencencies -c|--enable-code-coverage Enable code coverage
-d|--dependencies Install RCCL dependencies
--debug Build debug library --debug Build debug library
--enable_backtrace Build with custom backtrace support --enable_backtrace Build with custom backtrace support
--disable-colltrace Build without collective trace --disable-colltrace Build without collective trace
--disable-msccl-kernel Build without MSCCL kernels --disable-msccl-kernel Build without MSCCL kernels
--disable-mscclpp Build without MSCCL++ support --disable-mscclpp Build without MSCCL++ support
--enable-mscclpp-clip Build MSCCL++ with clip wrapper on bfloat16 and half addition routines
--disable-roctx Build without ROCTX logging
-f|--fast Quick-build RCCL (local gpu arch only, no backtrace, and collective trace support) -f|--fast Quick-build RCCL (local gpu arch only, no backtrace, and collective trace support)
-h|--help Prints this help message -h|--help Prints this help message
-i|--install Install RCCL library (see --prefix argument below) -i|--install Install RCCL library (see --prefix argument below)
-j|--jobs Specify how many parallel compilation jobs to run ($nproc by default) -j|--jobs Specify how many parallel compilation jobs to run ($nproc by default)
-l|--local_gpu_only Only compile for local GPU architecture -l|--local_gpu_only Only compile for local GPU architecture
--amdgpu_targets Only compile for specified GPU architecture(s). For multiple targets, seperate by ';' (builds for all supported GPU architectures by default) --amdgpu_targets Only compile for specified GPU architecture(s). For multiple targets, separate by ';' (builds for all supported GPU architectures by default)
--no_clean Don't delete files if they already exist --no_clean Don't delete files if they already exist
--npkit-enable Compile with npkit enabled --npkit-enable Compile with npkit enabled
--log-trace Build with log trace enabled (i.e. NCCL_DEBUG=TRACE)
--openmp-test-enable Enable OpenMP in rccl unit tests --openmp-test-enable Enable OpenMP in rccl unit tests
--roctx-enable Compile with roctx enabled (example usage: rocprof --roctx-trace ./rccl-program)
-p|--package_build Build RCCL package -p|--package_build Build RCCL package
--prefix Specify custom directory to install RCCL to (default: `/opt/rocm`) --prefix Specify custom directory to install RCCL to (default: `/opt/rocm`)
--rm-legacy-include-dir Remove legacy include dir Packaging added for file/folder reorg backward compatibility
--run_tests_all Run all rccl unit tests (must be built already) --run_tests_all Run all rccl unit tests (must be built already)
-r|--run_tests_quick Run small subset of rccl unit tests (must be built already) -r|--run_tests_quick Run small subset of rccl unit tests (must be built already)
--static Build RCCL as a static library instead of shared library --static Build RCCL as a static library instead of shared library
-t|--tests_build Build rccl unit tests, but do not run -t|--tests_build Build rccl unit tests, but do not run
--time-trace Plot the build time of RCCL (requires `ninja-build` package installed on the system) --time-trace Plot the build time of RCCL (requires `ninja-build` package installed on the system)
--verbose Show compile commands --verbose Show compile commands
--force-reduce-pipeline Force reduce_copy sw pipeline to be used for every reduce-based collectives and datatypes
``` ```
By default, RCCL builds for all GPU targets defined in `DEFAULT_GPUS` in `CMakeLists.txt`. To target specific GPU(s), and potentially reduce build time, use `--amdgpu_targets` as a `;` separated string listing GPU(s) to target. By default, RCCL builds for all GPU targets defined in `DEFAULT_GPUS` in `CMakeLists.txt`. To target specific GPU(s), and potentially reduce build time, use `--amdgpu_targets` as a `;` separated string listing GPU(s) to target.
@@ -137,6 +140,6 @@ python3 -m sphinx -T -E -b html -d _build/doctrees -D language=en . _build/html
## Copyright ## Copyright
All source code and accompanying documentation is copyright (c) 2015-2022, NVIDIA CORPORATION. All rights reserved. All source code and accompanying documentation is copyright (c) 2015-2025, NVIDIA CORPORATION. All rights reserved.
All modifications are copyright (c) 2019-2022 Advanced Micro Devices, Inc. All rights reserved. All modifications are copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved.
install.sh
+1 -1
View File
@@ -45,7 +45,7 @@ function display_help()
echo "RCCL build & installation helper script" echo "RCCL build & installation helper script"
echo " Options:" echo " Options:"
echo " --address-sanitizer Build with address sanitizer enabled" echo " --address-sanitizer Build with address sanitizer enabled"
echo " -c|--enable-code-coverage Enable Code Coverage" echo " -c|--enable-code-coverage Enable code coverage"
echo " -d|--dependencies Install RCCL dependencies" echo " -d|--dependencies Install RCCL dependencies"
echo " --debug Build debug library" echo " --debug Build debug library"
echo " --enable_backtrace Build with custom backtrace support" echo " --enable_backtrace Build with custom backtrace support"