Updates copyright year, adds descriptions for additional options to R…

…EADME, formatting.
rapidsai · Jan 3, 2025 · 27e1582 · 27e1582
1 parent 5cd70b5
commit 27e1582
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 7 deletions.
diff --git a/scripts/dask/README.md b/scripts/dask/README.md
@@ -26,12 +26,22 @@ the tools here.
  bash$ run-dask-process.sh workers
  ```
  The env var SCHEDULER_FILE must be set to the location where the scheduler
- will generate the scheduler JSON file. The same location is used by the
- workers to read the generated scheduler JSON file.
+ will generate the scheduler JSON file. The same env var is used by the
+ workers to locate the generated scheduler JSON file for reading.
 
  The script will ensure the scheduler is started before the workers when both
  are specified.
 
+ Additional options can be specified for using different communication
+ mechanisms:
+ ```
+   --tcp                   - initalize a TCP cluster (default)
+   --ucx                   - initialize a UCX cluster with NVLink
+   --ucxib | --ucx-ib      - initialize a UCX cluster with InfiniBand+NVLink
+ ```
+ Finally, the script can be run with `-h` or `--help` to see the full set of
+ options.
+
 ### wait_for_workers.py
 
  This script can be used to ensure all workers that are expected to be present

diff --git a/scripts/dask/run-dask-process.sh b/scripts/dask/run-dask-process.sh
@@ -1,5 +1,5 @@
 #!/bin/bash
-# Copyright (c) 2024, NVIDIA CORPORATION.
+# Copyright (c) 2024-2025, NVIDIA CORPORATION.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at
@@ -21,9 +21,9 @@ HELP="$0 [<app> ...] [<flag> ...]
    scheduler               - start dask scheduler
    workers                 - start dask workers
  and <flag> is:
-   --tcp                   - initalize a tcp cluster (default)
-   --ucx                   - initialize a ucx cluster with NVLink
-   --ucxib | --ucx-ib      - initialize a ucx cluster with IB+NVLink
+   --tcp                   - initalize a TCP cluster (default)
+   --ucx                   - initialize a UCX cluster with NVLink
+   --ucxib | --ucx-ib      - initialize a UCX cluster with InfiniBand+NVLink
    -h | --help             - print this text
 
  The cluster config order of precedence is any specification on the

diff --git a/scripts/dask/wait_for_workers.py b/scripts/dask/wait_for_workers.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2024, NVIDIA CORPORATION.
+# Copyright (c) 2024-2025, NVIDIA CORPORATION.
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at