Skip to content

Commit 25462ea

Browse files
committed
clarify parameter description
1 parent f00b3a7 commit 25462ea

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

python-package/lightgbm/dask.py

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -274,10 +274,12 @@ def _train(
274274
about the Dask cluster referenced by ``client``.
275275
276276
* ``local_listen_port``: port that each LightGBM worker opens a listening socket on,
277-
to accept connections from other workers. This can be differ from LightGBM worker
278-
to LightGBM worker, but does not have to.
279-
* ``machines``: a list of all machines in the cluster, plus a port to communicate
280-
over during initial setup of LightGBM's network
277+
to accept connections from other workers. This can be differ from LightGBM worker
278+
to LightGBM worker, but does not have to.
279+
* ``machines``: a comma-delimited list of all workers in the cluster, in the
280+
form ``ip:port,ip:port``. If running multiple Dask workers on the same host, use different
281+
ports for each worker. For example, for ``LocalCluster(n_workers=3)``, you might
282+
pass ``"127.0.0.1:12400,127.0.0.1:12401,127.0.0.1:12402"```.
281283
* ``num_machines``: number of LightGBM workers
282284
* ``timeout``: time in minutes to wait before closing unused sockets
283285

0 commit comments

Comments
 (0)