You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/quickstart.md
+73Lines changed: 73 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -92,6 +92,7 @@ There are a few optional CMake options you can set:
92
92
- `-DMSCCLPP_BUILD_PYTHON_BINDINGS=OFF`: Don't build the Python module.
93
93
- `-DMSCCLPP_BUILD_TESTS=OFF`: Don't build the tests.
94
94
- `-DMSCCLPP_BUILD_APPS_NCCL=OFF`: Don't build the NCCL API.
95
+
- `-DMSCCLPP_BUILD_EXT_TORCHCOMMS=ON`: Build [TorchComms](https://github.com/meta-pytorch/torchcomms) support for MSCCL++ (off by default). Requires PyTorch and pybind11.
MSCCL++ integrates with [TorchComms](https://github.com/meta-pytorch/torchcomms), enabling PyTorch users to use MSCCL++ collectives through the TorchComms API. This is the recommended way to use MSCCL++ in PyTorch training for mixed-backend setups (e.g., MSCCL++ for allreduce, NCCL for broadcast/barrier).
213
+
214
+
#### Building
215
+
216
+
Prerequisites: PyTorch, pybind11, and [torchcomms](https://github.com/meta-pytorch/torchcomms) (`pip install --pre torchcomms`).
217
+
218
+
```bash
219
+
$ mkdir -p build &&cd build
220
+
$ cmake -DCMAKE_BUILD_TYPE=Release \
221
+
-DMSCCLPP_BUILD_EXT_TORCHCOMMS=ON \
222
+
..
223
+
$ make -j$(nproc)
224
+
$ cd ..
225
+
```
226
+
227
+
This produces `_comms_mscclpp.*.so`in the build output. TorchComms discovers MSCCL++ via the `TORCHCOMMS_BACKEND_LIB_PATH_MSCCLPP` environment variable, where `MSCCLPP_BUILD` is your MSCCL++ build directory.
The MSCCL++ Python package includes comprehensive version tracking that captures git repository information at build time. This feature allows users to identify the exact source code version of their installed package.
0 commit comments