Skip to content
This repository was archived by the owner on Jan 12, 2026. It is now read-only.

Commit 3a18e05

Browse files
authored
[docs] update environment variable names in README (#198)
1 parent fc82d0a commit 3a18e05

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -512,7 +512,7 @@ to implement placement strategies for better fault tolerance.
512512
By default, a SPREAD strategy is used for training, which attempts to spread all of the training workers
513513
across the nodes in a cluster on a best-effort basis. This improves fault tolerance since it minimizes the
514514
number of worker failures when a node goes down, but comes at a cost of increased inter-node communication
515-
To disable this strategy, set the `USE_SPREAD_STRATEGY` environment variable to 0. If disabled, no
515+
To disable this strategy, set the `RXGB_USE_SPREAD_STRATEGY` environment variable to 0. If disabled, no
516516
particular placement strategy will be used.
517517

518518
Note that this strategy is used only when `elastic_training` is not used. If `elastic_training` is set to `True`,
@@ -524,7 +524,7 @@ goes down, it will be less likely to impact multiple trials.
524524

525525
When placement strategies are used, XGBoost-Ray will wait for 100 seconds for the required resources
526526
to become available, and will fail if the required resources cannot be reserved and the cluster cannot autoscale
527-
to increase the number of resources. You can change the `PLACEMENT_GROUP_TIMEOUT_S` environment variable to modify
527+
to increase the number of resources. You can change the `RXGB_PLACEMENT_GROUP_TIMEOUT_S` environment variable to modify
528528
how long this timeout should be.
529529

530530
More examples

0 commit comments

Comments
 (0)