#1359: LB: update documentation to reflect true threshold

DARMA-tasking · Sep 28, 2021 · b7d80fb · nlslatt · Sep 28, 2021 · nlslatt
1 parent 3af5300
commit b7d80fb
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 10 deletions.
diff --git 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: <double>
 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
@@ -80,11 +80,11 @@ HierarchicalLB::getInputKeysWithHelp() {
 Values: <double>
 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.
 )"
     },
     {