Skip to content

Commit

Permalink
Update install guidelines (#159)
Browse files Browse the repository at this point in the history
  • Loading branch information
chhwang authored Aug 30, 2023
1 parent 8d1b984 commit 3df18d2
Showing 1 changed file with 14 additions and 5 deletions.
19 changes: 14 additions & 5 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

## Build from Source

CMake 3.26 or later is required.
CMake 3.25 or later is required.

```bash
$ git clone https://github.com/microsoft/mscclpp.git
Expand All @@ -24,15 +24,23 @@ $ cmake -DCMAKE_BUILD_TYPE=Release ..
$ make -j
```

## Install from Source
## Install from Source (Libraries and Headers)

```bash
# Install the generated headers and binaries to /usr/local/mscclpp
$ cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr/local/mscclpp ..
$ make -j mscclpp
$ cmake -DCMAKE_BUILD_TYPE=Release -DCMAKE_INSTALL_PREFIX=/usr/local/mscclpp -DBUILD_PYTHON_BINDINGS=OFF ..
$ make -j mscclpp mscclpp_static
$ sudo make install/fast
```

## Install from Source (Python Module)

Python 3.8 or later is required.

```bash
$ python -m pip install .
```

## Docker Images

Our base image installs all prerequisites for MSCCL++.
Expand Down Expand Up @@ -65,9 +73,10 @@ $ mpirun -np 16 -npernode 8 -hostfile hostfile ./test/mp_unit_tests -ip_port 10.

## mscclpp-test

mscclpp-test is a set of performance benchmarks for MSCCL++. It requires MPI to be installed on the system.
mscclpp-test is a set of performance benchmarks for MSCCL++. It requires MPI to be installed on the system, and the path should be provided via `MPI_HOME` environment variable to the CMake build system.

```bash
$ MPI_HOME=/path/to/mpi cmake -DCMAKE_BUILD_TYPE=Release ..
$ make -j sendrecv_test_perf allgather_test_perf allreduce_test_perf alltoall_test_perf
```

Expand Down

0 comments on commit 3df18d2

Please sign in to comment.