Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[train/tune] Remove save_to_object/restore_from_object #38757

Merged
merged 4 commits into from
Aug 23, 2023

Conversation

krfricke
Copy link
Contributor

@krfricke krfricke commented Aug 22, 2023

Why are these changes needed?

This PR removes Trainable.save_to_object and Trainable.restore_from_object.

These methods were technically public (as they were part of a public class), but they were only used internally in practice. That's why we believe it's fine to remove them without a full deprecation cycle.

The methods stem from a time when a central storage location was not guaranteed. Then, we needed to be able to ship checkpoints between nodes - e.g. from the head node to the worker nodes where the trial is executed, or between nodes, e.g. when PBT trials exploit another trial.

These assumptions are now superseded by a central storage location. We require users to save checkpoints in a location which all nodes can access. We then only have to ship a thin metadata wrapper around, instead of the full serialized checkpoint data. For large checkpoints, this was always infeasible.

Related issue number

Closes #38674

Checks

  • I've signed off every commit(by using the -s flag, i.e., git commit -s) in this PR.
  • I've run scripts/format.sh to lint the changes in this PR.
  • I've included any doc changes needed for https://docs.ray.io/en/master/.
    • I've added any new APIs to the API Reference. For example, if I added a
      method in Tune, I've added it in doc/source/tune/api/ under the
      corresponding .rst file.
  • I've made sure the tests are passing. Note that there might be a few flaky tests, see the recent failures at https://flakey-tests.ray.io/
  • Testing Strategy
    • Unit tests
    • Release tests
    • This PR is not tested :(

Signed-off-by: Kai Fricke <kai@anyscale.com>
Copy link
Contributor

@justinvyu justinvyu left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great thanks! Stamping for now.

Kai Fricke added 3 commits August 23, 2023 00:29
Signed-off-by: Kai Fricke <kai@anyscale.com>
Signed-off-by: Kai Fricke <kai@anyscale.com>
Copy link
Contributor

@sven1977 sven1977 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me. Thanks @krfricke !

@krfricke krfricke merged commit 2d0544b into ray-project:master Aug 23, 2023
62 of 70 checks passed
@krfricke krfricke deleted the tune/remove-save-restore-obj branch August 23, 2023 10:17
arvind-chandra pushed a commit to lmco/ray that referenced this pull request Aug 31, 2023
…8757)

This PR removes `Trainable.save_to_object` and `Trainable.restore_from_object`.

These methods were technically public (as they were part of a public class), but they were only used internally in practice. That's why we believe it's fine to remove them without a full deprecation cycle.

The methods stem from a time when a central storage location was not guaranteed. Then, we needed to be able to ship checkpoints between nodes - e.g. from the head node to the worker nodes where the trial is executed, or between nodes, e.g. when PBT trials exploit another trial.

These assumptions are now superseded by a central storage location. We require users to save checkpoints in a location which all nodes can access. We then only have to ship a thin metadata wrapper around, instead of the full serialized checkpoint data. For large checkpoints, this was always infeasible.

Signed-off-by: Kai Fricke <kai@anyscale.com>
Signed-off-by: e428265 <arvind.chandramouli@lmco.com>
vymao pushed a commit to vymao/ray that referenced this pull request Oct 11, 2023
…8757)

This PR removes `Trainable.save_to_object` and `Trainable.restore_from_object`.

These methods were technically public (as they were part of a public class), but they were only used internally in practice. That's why we believe it's fine to remove them without a full deprecation cycle.

The methods stem from a time when a central storage location was not guaranteed. Then, we needed to be able to ship checkpoints between nodes - e.g. from the head node to the worker nodes where the trial is executed, or between nodes, e.g. when PBT trials exploit another trial.

These assumptions are now superseded by a central storage location. We require users to save checkpoints in a location which all nodes can access. We then only have to ship a thin metadata wrapper around, instead of the full serialized checkpoint data. For large checkpoints, this was always infeasible.

Signed-off-by: Kai Fricke <kai@anyscale.com>
Signed-off-by: Victor <vctr.y.m@example.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[train][GA] Hard-deprecate Trainable.save_to_object and Trainable.restore_to_object
4 participants