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] Better document resource dict and its relationship to num_cpu, etc. #48709

Open
scottsun94 opened this issue Nov 12, 2024 · 0 comments
Open
Labels
core Issues that should be addressed in Ray Core docs An issue or change related to documentation P2 Important issue, but not time-critical

Comments

@scottsun94
Copy link
Contributor

Description

@pcmoritz mentioned that num_cpus=n is a ray.remote argument which is a convenient short hand for resources={"CPU": n}, and whenever we expect a resource dict, the only way to really specify it is via {"CPU": n}.

We should better document this:

  • having a section in the docs on what exactly a resource dict is and how it relates to num_cpu
  • link to this section from wherever we expect resource dicts.

Link

No response

@scottsun94 scottsun94 added triage Needs triage (eg: priority, bug/not-bug, and owning component) docs An issue or change related to documentation core Issues that should be addressed in Ray Core labels Nov 12, 2024
@rynewang rynewang added P2 Important issue, but not time-critical and removed triage Needs triage (eg: priority, bug/not-bug, and owning component) labels Nov 12, 2024
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 P2 Important issue, but not time-critical
Projects
None yet
Development

No branches or pull requests

2 participants