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] shall we document __ray_call__ as a public API? #45068

Open
Atry opened this issue May 1, 2024 · 2 comments
Open

[Core] shall we document __ray_call__ as a public API? #45068

Atry opened this issue May 1, 2024 · 2 comments
Labels
core Issues that should be addressed in Ray Core docs An issue or change related to documentation good first issue Great starter issue for someone just starting to contribute to Ray P1 Issue that should be fixed within a few weeks

Comments

@Atry
Copy link
Contributor

Atry commented May 1, 2024

Description

Ray users are creating helper functions similar to __ray_call__, for example: https://github.com/vllm-project/vllm/blob/d6f4bd7cddc9546c38568c92c3772d22940a09f2/vllm/worker/worker_base.py#L135

If we make __ray_call__ a public API, we will have a standard way to run a closure remotely.

Link

https://docs.ray.io/en/latest/search.html?q=__ray_call__

@Atry Atry added docs An issue or change related to documentation triage Needs triage (eg: priority, bug/not-bug, and owning component) labels May 1, 2024
@Atry Atry changed the title [Core] Should __ray_call__ be documented as a public API? [Core] shall we document __ray_call__ as a public API? May 1, 2024
@anyscalesam anyscalesam added the core Issues that should be addressed in Ray Core label May 2, 2024
@jjyao jjyao added good first issue Great starter issue for someone just starting to contribute to Ray P1 Issue that should be fixed within a few weeks and removed triage Needs triage (eg: priority, bug/not-bug, and owning component) labels May 6, 2024
@elainechan01
Copy link

Hey there, I'm interested in contributing to this issue as a first-time contributor. I would love to learn more about this issue to better understand how I can help out. Any additional context you can provide would be greatly appreciated.

  • Are we referring to this method?
    def __call__(self, *args, **kwargs):
  • Are we aiming to convert this method into a public method or are we just updating the docs?
    • If we're converting the method into a public method, are there any items I should be aware of e.g., decorators to include etc.

Thank you!

@Atry
Copy link
Contributor Author

Atry commented May 30, 2024 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Issues that should be addressed in Ray Core docs An issue or change related to documentation good first issue Great starter issue for someone just starting to contribute to Ray P1 Issue that should be fixed within a few weeks
Projects
None yet
Development

No branches or pull requests

4 participants