diff --git a/README b/README index 01e0b721a26..2c3ea2c8c7d 100644 --- a/README +++ b/README @@ -51,7 +51,7 @@ $ make install ``` NOTE: Compiling support for various networks or other specific hardware may -require additional command line flags when running configure. +require additional command line flags when running "configure". ### Developer Builds @@ -69,17 +69,17 @@ penalty at run-time because of extra debugging code. $ make -C test/gtest test ``` -### Build RPM package +### Building RPM package ```bash $ contrib/buildrpm.sh -s -b ``` -### Build DEB package +### Building DEB package ```bash $ dpkg-buildpackage -us -uc ``` -### Build Doxygen documentation +### Building Doxygen documentation ```bash $ make docs ``` @@ -92,18 +92,18 @@ $ make docs ### UCX Performance Test -Start server: +Start the server: ```sh $ ./src/tools/perf/ucx_perftest -c 0 ``` -Connect client: +Connect to the client: ```sh $ ./src/tools/perf/ucx_perftest -t tag_lat -c 1 ``` -Note: the `-c` flag sets CPU affinity. If running both commands on same host, make sure you set the affinity to different CPU cores. +Note: The -c flag sets CPU affinity. To run both commands on the same host, set the affinity to different CPU cores. ## Our Community @@ -185,7 +185,7 @@ To reference the UCX website: ## Huawei Optimization Introduction -Based on performance consideration, UCX **DO NOT** provide the functionalities related to transmission security. +Based on performance consideration, UCX **DOES NOT** provide the functionalities related to transmission security. There are three optimized collective operations: @@ -203,7 +203,7 @@ New algorithms are as follows: - Topo-aware Recursive + Binomial(intra) - Topo-aware Recursive + K-nomial(intra) -Select specific algorithm with parameters which is showed in the table below. +Select a specific algorithm with parameters which are described in the tables below. Bcast: