Skip to content

Commit e2c9f2f

Browse files
authored
Update help text in README (#1837)
1 parent 5ecc1b7 commit e2c9f2f

File tree

2 files changed

+10
-7
lines changed

2 files changed

+10
-7
lines changed

README.md

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,31 +34,34 @@ For more info on build options/flags when using the install script, use `./insta
3434
RCCL build & installation helper script
3535
Options:
3636
--address-sanitizer Build with address sanitizer enabled
37-
-d|--dependencies Install RCCL depdencencies
37+
-c|--enable-code-coverage Enable code coverage
38+
-d|--dependencies Install RCCL dependencies
3839
--debug Build debug library
3940
--enable_backtrace Build with custom backtrace support
4041
--disable-colltrace Build without collective trace
4142
--disable-msccl-kernel Build without MSCCL kernels
4243
--disable-mscclpp Build without MSCCL++ support
44+
--enable-mscclpp-clip Build MSCCL++ with clip wrapper on bfloat16 and half addition routines
45+
--disable-roctx Build without ROCTX logging
4346
-f|--fast Quick-build RCCL (local gpu arch only, no backtrace, and collective trace support)
4447
-h|--help Prints this help message
4548
-i|--install Install RCCL library (see --prefix argument below)
4649
-j|--jobs Specify how many parallel compilation jobs to run ($nproc by default)
4750
-l|--local_gpu_only Only compile for local GPU architecture
48-
--amdgpu_targets Only compile for specified GPU architecture(s). For multiple targets, seperate by ';' (builds for all supported GPU architectures by default)
51+
--amdgpu_targets Only compile for specified GPU architecture(s). For multiple targets, separate by ';' (builds for all supported GPU architectures by default)
4952
--no_clean Don't delete files if they already exist
5053
--npkit-enable Compile with npkit enabled
54+
--log-trace Build with log trace enabled (i.e. NCCL_DEBUG=TRACE)
5155
--openmp-test-enable Enable OpenMP in rccl unit tests
52-
--roctx-enable Compile with roctx enabled (example usage: rocprof --roctx-trace ./rccl-program)
5356
-p|--package_build Build RCCL package
5457
--prefix Specify custom directory to install RCCL to (default: `/opt/rocm`)
55-
--rm-legacy-include-dir Remove legacy include dir Packaging added for file/folder reorg backward compatibility
5658
--run_tests_all Run all rccl unit tests (must be built already)
5759
-r|--run_tests_quick Run small subset of rccl unit tests (must be built already)
5860
--static Build RCCL as a static library instead of shared library
5961
-t|--tests_build Build rccl unit tests, but do not run
6062
--time-trace Plot the build time of RCCL (requires `ninja-build` package installed on the system)
6163
--verbose Show compile commands
64+
--force-reduce-pipeline Force reduce_copy sw pipeline to be used for every reduce-based collectives and datatypes
6265
```
6366
6467
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
137140
138141
## Copyright
139142
140-
All source code and accompanying documentation is copyright (c) 2015-2022, NVIDIA CORPORATION. All rights reserved.
143+
All source code and accompanying documentation is copyright (c) 2015-2025, NVIDIA CORPORATION. All rights reserved.
141144
142-
All modifications are copyright (c) 2019-2022 Advanced Micro Devices, Inc. All rights reserved.
145+
All modifications are copyright (c) 2019-2025 Advanced Micro Devices, Inc. All rights reserved.

install.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ function display_help()
4545
echo "RCCL build & installation helper script"
4646
echo " Options:"
4747
echo " --address-sanitizer Build with address sanitizer enabled"
48-
echo " -c|--enable-code-coverage Enable Code Coverage"
48+
echo " -c|--enable-code-coverage Enable code coverage"
4949
echo " -d|--dependencies Install RCCL dependencies"
5050
echo " --debug Build debug library"
5151
echo " --enable_backtrace Build with custom backtrace support"

0 commit comments

Comments
 (0)