Documentation: Modify README to support NCCL v2.6.4

This patch alters README to add support for NCCL v2.6.4 and new configuration option `--enable-trace` to toggle printing TRACE messages. Signed-off-by: Rashika Kheria <[email protected]>
aws · May 29, 2020 · 2838d10 · 2838d10
1 parent dff97df
commit 2838d10
Showing 1 changed file with 11 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -28,7 +28,10 @@ The plug-in currently supports the following distributions:
 
 It also requires
 [Libfabric v1.9.x](https://github.com/ofiwg/libfabric/tree/v1.9.x)
-and supports [NCCL v2.5.6](https://github.com/NVIDIA/nccl/releases/tag/v2.5.6-2).
+and supports [NCCL v2.6.4](https://github.com/NVIDIA/nccl/releases/tag/v2.6.4-1).
+The plug-in also maintains backward compatibility with older NCCL versions
+[NCCL v2.4.x](https://github.com/NVIDIA/nccl/releases/tag/v2.4.8-1) and
+[NCCL v2.5.x](https://github.com/NVIDIA/nccl/releases/tag/v2.5.7-1)
 
 Libfabric supports various providers. The plug-in can choose only those which
 support the following features as defined in the
@@ -71,6 +74,13 @@ dependencies with the following flags:
   --with-mpi=PATH         Path to non-standard MPI installation
 ```
 
+To enable trace messages for debugging (disabled by default), use the
+following config option:
+
+```
+   --enable-trace         Enable printing trace messages
+```
+
 ### Running Unit Tests
 
 Running unit tests requires a working MPI installation and a