[2.5.0][air] Store unflattened metrics in _TrackedCheckpoint #35706
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
) We currently store metrics associated with a tracked AIR checkpoint in flattened format. This was done so we can specify nested keys in e.g. `checkpoint_score_attr`, which determines which checkpoints to keep. However, we also rely on these stored metrics to restore the `trial.last_result` property when restoring from a checkpoint. Since ray-project#35000, we unflatten the dict there to resolve issues where we relied on the original structure in `trial.last_result`. This again leads to issues with metrics in e.g. pytorch lightning, where some metrics are reported with a `/` (our default flatten separator). Or in a nutshell, `dict != unflatten(flatten(dict))` when the separator can be contained in the dict keys. Some users may prefer to report with `/`, since it shows up nicely as nested metrics in wandb. The proper resolution here is to not flatten the metrics at all. Instead, we should use `unflattened_lookup` to lookup the `checkpoint_score_attr` from the original metrics dict. This PR updates the `_TrackedCheckpoint` to retain the unflattened metrics. Signed-off-by: Kai Fricke <[email protected]>
|
Thanks for the work @krfricke @matthewdeng and @gjoliver : is this critical enough to warrant a cherry pick vs. having it in 2.6? |
matthewdeng
approved these changes
May 24, 2023
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?
Pick of 5acf41e
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.