[tune] Simplify experiment tag formatting, clean directory names #23672
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
krfricke
commented
Apr 2, 2022
| if isinstance(value, float): | ||
| return "{:.5}".format(value) | ||
| return f"{value:.4f}" |
edoakes
pushed a commit
to edoakes/ray
that referenced
this pull request
Apr 7, 2022
…-project#23672) Experiment tags are not always rendered in a sane way for all operating systems. For instance, a config of ``` "a": tune.choice([(3, 4), (5, 6)]), "b": tune.choice([[7, 8], [6, 5]]), ``` will lead to an experiment dir like `lambda_53737_00000_0_a=_3, 4_,b=[7, 8]_2022-04-02_10-21-27/`. This can lead to problems with utilities such as gsutil (which misinterprets some characters as wildcards, see ray-project#23670), but also with e.g. MacOS which doesn't like `[` brackets in filenames. This PR adds an improvement to the `_clean_value` function used to sanitize values. We specify a valid alphabet which includes a limited set of characters that is broadly usable in most operating systems. We also simplify the `format_vars` function - even though it was previously a bit more sophisticated in handling list items, this was error-prone, and can be replaced in favor of a better readable and simpler implementation that yields the same results in almost all cases.
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?
Experiment tags are not always rendered in a sane way for all operating systems. For instance, a config of
will lead to an experiment dir like
lambda_53737_00000_0_a=_3, 4_,b=[7, 8]_2022-04-02_10-21-27/. This can lead to problems with utilities such as gsutil (which misinterprets some characters as wildcards, see #23670), but also with e.g. MacOS which doesn't like[brackets in filenames.This PR adds an improvement to the
_clean_valuefunction used to sanitize values. We specify a valid alphabet which includes a limited set of characters that is broadly usable in most operating systems. We also simplify theformat_varsfunction - even though it was previously a bit more sophisticated in handling list items, this was error-prone, and can be replaced in favor of a better readable and simpler implementation that yields the same results in almost all cases.Related issue number
Closes #23670
Checks
scripts/format.shto lint the changes in this PR.