From 11f8f8bd8c008ac4259eabeeee5a2321a4becf35 Mon Sep 17 00:00:00 2001 From: Robert Nishihara Date: Thu, 9 Nov 2017 17:02:18 -0800 Subject: [PATCH] Document --num-workers better. (#1201) --- python/ray/scripts/scripts.py | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/python/ray/scripts/scripts.py b/python/ray/scripts/scripts.py index 2d1603f88..ed047aae9 100644 --- a/python/ray/scripts/scripts.py +++ b/python/ray/scripts/scripts.py @@ -54,7 +54,10 @@ def cli(): @click.option("--object-manager-port", required=False, type=int, help="the port to use for starting the object manager") @click.option("--num-workers", required=False, type=int, - help="the initial number of workers to start on this node") + help=("The initial number of workers to start on this node, " + "note that the local scheduler may start additional " + "workers. If you wish to control the total number of " + "concurent tasks, then use --num-cpus instead.")) @click.option("--num-cpus", required=False, type=int, help="the number of CPUs on this node") @click.option("--num-gpus", required=False, type=int,