[train][doc] Add documentation on RAY_CHDIR_TO_TRIAL_DIR environment variable
#42891
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Justin Yu <[email protected]>
justinvyu
requested review from
richardliaw,
krfricke,
xwjiang2010,
amogkam,
matthewdeng,
Yard1,
maxpumperla,
woshiyyya and
a team
as code owners
matthewdeng
reviewed
Feb 1, 2024
Signed-off-by: Justin Yu <[email protected]>
Signed-off-by: Justin Yu <[email protected]>
…ment_chdir_behavior
matthewdeng
approved these changes
Feb 2, 2024
tterrysun
pushed a commit
to tterrysun/ray
that referenced
this pull request
Feb 14, 2024
…t variable (ray-project#42891) This environment variable can be used to disable Ray Train's default behavior of changing the working directory to the trial directory. There is already an FAQ section about this in Ray Tune, but no documentation for Ray Train users, so this PR adds that. --------- Signed-off-by: Justin Yu <[email protected]> Signed-off-by: tterrysun <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why are these changes needed?
This environment variable can be used to disable Ray Train's default behavior of changing the working directory to the trial directory. There is already an FAQ section about this in Ray Tune, but no documentation for Ray Train users, so this PR adds that.
Related issue number
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.