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

[core] Add generic __ray_ready__ method to Actor classes #31997

Merged
merged 3 commits into from
Jan 30, 2023

Conversation

krfricke
Copy link
Contributor

@krfricke krfricke commented Jan 27, 2023

Signed-off-by: Kai Fricke kai@anyscale.com

Why are these changes needed?

We currently have no canonical way to await actors. Users can define their own is-ready methods, schedule a future, and await these, but this has to be done for every actor class separately.

This does not match other patterns - e.g. we have actor.__ray_terminate__.remote() for actor termination and placement_group.ready() for placement group ready futures.

This PR adds a new __ray_ready__ magic actor method that just returns True. It can be used to await actors becoming ready (newly scheduled actors), and actors having processed all of their other enqueued tasks.

Related issue number

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 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>
@krfricke krfricke requested a review from ericl January 27, 2023 17:02
@ericl ericl added the core-interface-change-approval-required This changes the Ray core behavior / API and requires broader approvals. label Jan 27, 2023
Signed-off-by: Kai Fricke <kai@anyscale.com>
Copy link
Collaborator

@jjyao jjyao left a comment

Choose a reason for hiding this comment

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

Could you update the related docs?

@krfricke
Copy link
Contributor Author

@jjyao __ray_terminate__ is also not documented - is this something we want to expose more broadly?

@krfricke krfricke merged commit fe729aa into ray-project:master Jan 30, 2023
@krfricke krfricke deleted the core/ray-active branch January 30, 2023 22:07
clarng pushed a commit to clarng/ray that referenced this pull request Jan 31, 2023
…ct#31997)

We currently have no canonical way to await actors. Users can define their own _is-ready_ methods, schedule a future, and await these, but this has to be done for every actor class separately.

This does not match other patterns - e.g. we have `actor.__ray_terminate__.remote()` for actor termination and `placement_group.ready()` for placement group ready futures.

This PR adds a new `__ray_ready__` magic actor method that just returns `True`. It can be used to await actors becoming ready (newly scheduled actors), and actors having processed all of their other enqueued tasks.

Signed-off-by: Kai Fricke <kai@anyscale.com>
edoakes pushed a commit to edoakes/ray that referenced this pull request Mar 22, 2023
…ct#31997)

We currently have no canonical way to await actors. Users can define their own _is-ready_ methods, schedule a future, and await these, but this has to be done for every actor class separately.

This does not match other patterns - e.g. we have `actor.__ray_terminate__.remote()` for actor termination and `placement_group.ready()` for placement group ready futures.

This PR adds a new `__ray_ready__` magic actor method that just returns `True`. It can be used to await actors becoming ready (newly scheduled actors), and actors having processed all of their other enqueued tasks.

Signed-off-by: Kai Fricke <kai@anyscale.com>
Signed-off-by: Edward Oakes <ed.nmi.oakes@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core-interface-change-approval-required This changes the Ray core behavior / API and requires broader approvals.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants