From b7d80fbaafd7f85e7002e0bc0865c82c61f1b25c Mon Sep 17 00:00:00 2001 From: Jonathan Lifflander Date: Tue, 28 Sep 2021 12:47:48 -0700 Subject: [PATCH] #1359: LB: update documentation to reflect true threshold --- src/vt/vrt/collection/balance/greedylb/greedylb.cc | 9 ++++----- src/vt/vrt/collection/balance/hierarchicallb/hierlb.cc | 10 +++++----- 2 files changed, 9 insertions(+), 10 deletions(-) diff --git a/src/vt/vrt/collection/balance/greedylb/greedylb.cc b/src/vt/vrt/collection/balance/greedylb/greedylb.cc index 71098eaa2e..4e21a433ab 100644 --- a/src/vt/vrt/collection/balance/greedylb/greedylb.cc +++ b/src/vt/vrt/collection/balance/greedylb/greedylb.cc @@ -81,11 +81,10 @@ GreedyLB::getInputKeysWithHelp() { Values: Default: 0.8 Description: - The load threshold for objects to consider on each node. The default value of - 0.8 will consider 80% of the average load for re-balancing on each node. The - order these will be selected is based on the value passed to "strategy". If - the parameter "auto" is set to "true", this will be the minimum threshold; - otherwise, it sets the threshold directly. + The load threshold of objects to consider for potential migration on each + rank. All objects over threshold * average_load on each rank will + considered. If the parameter "auto" is set to "true", this will be the minimum + threshold; otherwise, it sets the threshold directly. )" }, { diff --git a/src/vt/vrt/collection/balance/hierarchicallb/hierlb.cc b/src/vt/vrt/collection/balance/hierarchicallb/hierlb.cc index 7381eae4d3..03d13b077b 100644 --- a/src/vt/vrt/collection/balance/hierarchicallb/hierlb.cc +++ b/src/vt/vrt/collection/balance/hierarchicallb/hierlb.cc @@ -80,11 +80,11 @@ HierarchicalLB::getInputKeysWithHelp() { Values: Default: 0.8 Description: - The load threshold for objects to consider on each node. The default value of - 0.8 will consider 80% of the average load for re-balancing on each node. The - order these will be selected is based on the value passed to "strategy". If - the parameter "auto" is set to "true", this will be the minimum threshold; - otherwise, it sets the threshold directly. + The load threshold of objects to consider for potential migration on each + rank. All objects over threshold * average_load on each rank will + considered. The order these will be selected is based on the value passed to + "strategy". If the parameter "auto" is set to "true", this will be the minimum + threshold; otherwise, it sets the threshold directly. )" }, {