Skip to content

Commit

Permalink
README: Update perftest example and UCX layers desc
Browse files Browse the repository at this point in the history
  • Loading branch information
yosefe committed May 13, 2018
1 parent 4eb2ca4 commit cd88e5d
Showing 1 changed file with 25 additions and 9 deletions.
34 changes: 25 additions & 9 deletions README
Expand Up @@ -9,18 +9,34 @@ $ make
$ make -C test/gtest test
```

### Running UCX performance test
### Running UCX hello-world
Compile:

```sh
$ export PATH=$PATH:$MPI_HOME/bin
$ ./autogen.sh
$ ./contrib/configure-release --prefix=$PWD/install --with-mpi
$ make -j8 install
$ salloc -N2 --ntasks-per-node=1 mpirun --display-map \
$PWD/install/bin/ucx_perftest -d mlx5_1:1 -x rc_mlx5 -c 12 -t put_lat
$ ./contrib/configure-release --prefix=$PWD/install
$ make
```
Start server:

```sh
$ ./src/tools/perf/ucx_perftest -c 0
```

Connect client:

```sh
$ ./src/tools/perf/ucx_perftest <server-hostname> -t tag_lat -c 0
```

### UCX high-level layout
- UCX - Unified Communication X
- UCP - UCX Protocol
- UCT - UCX Transport
- UCS - UCX Services
- UCP - UCX Protocol. Implements high-level abstractions such as tag-matching,
streams, connection negotiation and establishment, multi-rail, and handling
different memory types.
- UCT - UCX Transport. Implements low-level communication primitives such as
active messages, remote memory access, and atomic operations.
- UCS - UCX Services. A collection of data structures, algorithms, and system
utilities for common use.
- UCM - UCX Memory. Intercepts memory allocation and release events, used by
memory registration cache.

0 comments on commit cd88e5d

Please sign in to comment.