mscclpp

mirror of https://github.com/microsoft/mscclpp.git synced 2026-05-12 01:10:22 +00:00

Files

Changho Hwang 9e076da3d4 Make IB more configurable (#703 )

* Added `port` and `gidIndex` field in the IB endpoint config (and
`deviceIndex` field for future usages)
* Added `MSCCLPP_IBV_SO` env variable to specify a custom libibverbs.so
* Added `--ib_gid_index` CLI option to `mp_unit_tests`
* Other minor fixes

2025-12-18 13:21:07 -08:00

_static

Update documentation (#576 )

2025-08-07 15:37:37 -07:00

figs

Improving DSL documentation (#650 )

2025-10-23 17:50:33 -07:00

guide

Integrate MSCCL++ DSL to torch workload (#620 )

2025-10-29 15:39:00 -07:00

tutorials

Make IB more configurable (#703 )

2025-12-18 13:21:07 -08:00

.gitignore

python doc auto generation (#605 )

2025-08-11 10:34:29 -07:00

conf.py

Integrate MSCCL++ DSL to torch workload (#620 )

2025-10-29 15:39:00 -07:00

cpp_api.rst

Fix docs (#656 )

2025-10-23 00:34:53 +00:00

Doxyfile

Fix docs (#656 )

2025-10-23 00:34:53 +00:00

dsl_quick_start.md

DSL Quick Start (#689 )

2025-11-21 14:45:49 -08:00

dsl.rst

Creating Documentation Section for MSCCL++ DSL (#706 )

2025-12-15 15:07:01 -08:00

index.rst

Creating Documentation Section for MSCCL++ DSL (#706 )

2025-12-15 15:07:01 -08:00

make.bat

Update documentation (#217 )

2023-11-22 12:58:04 -08:00

Makefile

Fix docs (#656 )

2025-10-23 00:34:53 +00:00

overview.md

Update documentation (#576 )

2025-08-07 15:37:37 -07:00

programming_guide.rst

Creating Documentation Section for MSCCL++ DSL (#706 )

2025-12-15 15:07:01 -08:00

py_api.rst

Fix docs (#656 )

2025-10-23 00:34:53 +00:00

quickstart.md

Fixes for no-IB systems (#667 )

2025-10-29 10:03:02 -07:00

README.md

[Doc] mscclpp docs (#348 )

2024-10-18 06:08:31 +00:00

requirements.txt

Fix docs (#656 )

2025-10-23 00:34:53 +00:00

tutorials.rst

Update documentation (#576 )

2025-08-07 15:37:37 -07:00

README.md

How to build docs

Install doxygen.

$ sudo apt-get install doxygen graphviz

Install Python packages below. If you install them on the user's local, you need to include ~/.local/bin to $PATH (to use sphinx-build).
```
$ sudo python3 -m pip install -r ./requirements.txt
```
Create Doxygen documents.
```
$ doxygen
```
Create Sphinx documents.
```
$ make html
```
Done. The HTML files will be on _build/ directory.