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

[air output] Update wording to "Logical Resource Usage". #33312

Merged
merged 7 commits into from
Mar 16, 2023

Conversation

xwjiang2010
Copy link
Contributor

@xwjiang2010 xwjiang2010 commented Mar 14, 2023

Update wording to "Logical Resource Usage" and remove heap/object memory stuff.

Remove memory_debug_str on head node. Remove runner.debug_str (dangling code path and duplicated logic with what's used in tune.run - I don't think people will debug trial_runner by itself these days)

Why are these changes needed?

Related issue number

#33152

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 :(

Update wording to "Logical Resource Usage" and remove heap/object memory stuff.

Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>
@xwjiang2010
Copy link
Contributor Author

bunch of rllib test failures that I don't think relevant.

Copy link
Contributor

@krfricke krfricke left a comment

Choose a reason for hiding this comment

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

Code looks good, just two questions:

  1. Is "Logical Resource Usage" the correct term here? I don't know what it means. What is a logical resource? Maybe "Resources used" or "Assigned resources" or so?
  2. Can we make sure this is found in the documentation somewhere?

@krfricke krfricke added the @author-action-required The PR author is responsible for the next step. Remove tag to send back to the reviewer. label Mar 15, 2023
@xwjiang2010
Copy link
Contributor Author

xwjiang2010 commented Mar 15, 2023

Code looks good, just two questions:

  1. Is "Logical Resource Usage" the correct term here? I don't know what it means. What is a logical resource? Maybe "Resources used" or "Assigned resources" or so?
  2. Can we make sure this is found in the documentation somewhere?

"Logical Resource" is in contrast to "Physical Resource". @scottsun94 in his user research, encountered people confused about this. Hence the emphasis on "Logical".

"Usage" is also surfaced as preference from user research cc @scottsun94
To me, it's the same as granted/used/assigned etc.

I have no preference on any of the terms (apart from "Requested" is clearly misleading) - just wants to follow design suggestions here.

Agree that we should make sure that our terminology is consistent. @scottsun94 do you know where ray doc uses those terms?

@xwjiang2010
Copy link
Contributor Author

xwjiang2010 commented Mar 15, 2023

Actually @krfricke I found it here!
https://docs.ray.io/en/latest/ray-core/scheduling/resources.html#physical-resources-and-logical-resources

So seems a valid terminology to me!

@scottsun94
Copy link
Contributor

In Ray core, we already have a dedicated "Resource" doc page and talk about the difference between "logical resource" and "physical resource"

The gap I found is that people using AIR don't really understand the distinction between logical resources and physical hardware utilization. For example, in my chat with relatively new ray users like @woshiyyya, they don't really know that "resource" refers to the logical resource concept purely for scheduling.

In the long term, we probably need to introduce the "ray resource" or "logical resource" concept into AIR's doc because people shouldn't have to look at ray core doc to use AIR.

I'm fine with going with "Resource usage" for now, being a bit ambiguous before we add the related doc into AIR.

@richardliaw Any thoughts here on how we could better fill the gap?

Copy link
Contributor

@krfricke krfricke left a comment

Choose a reason for hiding this comment

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

Logical resource usage is fine with me if we consistently use this term and users understand it.

python/ray/tune/utils/resource_updater.py Outdated Show resolved Hide resolved
python/ray/tune/utils/resource_updater.py Outdated Show resolved Hide resolved
@xwjiang2010 xwjiang2010 removed the @author-action-required The PR author is responsible for the next step. Remove tag to send back to the reviewer. label Mar 16, 2023
xwjiang2010 and others added 2 commits March 15, 2023 18:02
Co-authored-by: Kai Fricke <krfricke@users.noreply.github.com>
Signed-off-by: xwjiang2010 <87673679+xwjiang2010@users.noreply.github.com>
Co-authored-by: Kai Fricke <krfricke@users.noreply.github.com>
Signed-off-by: xwjiang2010 <87673679+xwjiang2010@users.noreply.github.com>
@xwjiang2010 xwjiang2010 merged commit eec7e06 into ray-project:master Mar 16, 2023
ProjectsByJackHe pushed a commit to ProjectsByJackHe/ray that referenced this pull request Mar 21, 2023
…#33312)

* [air output] Update wording to "Logical Resource Usage".

Update wording to "Logical Resource Usage" and remove heap/object memory stuff.

Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>

* further ax a few extra stuff.

* remove runner.debug_str

Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>

* Update python/ray/tune/utils/resource_updater.py

Co-authored-by: Kai Fricke <krfricke@users.noreply.github.com>
Signed-off-by: xwjiang2010 <87673679+xwjiang2010@users.noreply.github.com>

* Update python/ray/tune/utils/resource_updater.py

Co-authored-by: Kai Fricke <krfricke@users.noreply.github.com>
Signed-off-by: xwjiang2010 <87673679+xwjiang2010@users.noreply.github.com>

---------

Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>
Signed-off-by: xwjiang2010 <87673679+xwjiang2010@users.noreply.github.com>
Co-authored-by: Kai Fricke <krfricke@users.noreply.github.com>
Signed-off-by: Jack He <jackhe2345@gmail.com>
edoakes pushed a commit to edoakes/ray that referenced this pull request Mar 22, 2023
…#33312)

* [air output] Update wording to "Logical Resource Usage".

Update wording to "Logical Resource Usage" and remove heap/object memory stuff.

Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>

* further ax a few extra stuff.

* remove runner.debug_str

Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>

* Update python/ray/tune/utils/resource_updater.py

Co-authored-by: Kai Fricke <krfricke@users.noreply.github.com>
Signed-off-by: xwjiang2010 <87673679+xwjiang2010@users.noreply.github.com>

* Update python/ray/tune/utils/resource_updater.py

Co-authored-by: Kai Fricke <krfricke@users.noreply.github.com>
Signed-off-by: xwjiang2010 <87673679+xwjiang2010@users.noreply.github.com>

---------

Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>
Signed-off-by: xwjiang2010 <87673679+xwjiang2010@users.noreply.github.com>
Co-authored-by: Kai Fricke <krfricke@users.noreply.github.com>
Signed-off-by: Edward Oakes <ed.nmi.oakes@gmail.com>
peytondmurray pushed a commit to peytondmurray/ray that referenced this pull request Mar 22, 2023
…#33312)

* [air output] Update wording to "Logical Resource Usage".

Update wording to "Logical Resource Usage" and remove heap/object memory stuff.

Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>

* further ax a few extra stuff.

* remove runner.debug_str

Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>

* Update python/ray/tune/utils/resource_updater.py

Co-authored-by: Kai Fricke <krfricke@users.noreply.github.com>
Signed-off-by: xwjiang2010 <87673679+xwjiang2010@users.noreply.github.com>

* Update python/ray/tune/utils/resource_updater.py

Co-authored-by: Kai Fricke <krfricke@users.noreply.github.com>
Signed-off-by: xwjiang2010 <87673679+xwjiang2010@users.noreply.github.com>

---------

Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>
Signed-off-by: xwjiang2010 <87673679+xwjiang2010@users.noreply.github.com>
Co-authored-by: Kai Fricke <krfricke@users.noreply.github.com>
elliottower pushed a commit to elliottower/ray that referenced this pull request Apr 22, 2023
…#33312)

* [air output] Update wording to "Logical Resource Usage".

Update wording to "Logical Resource Usage" and remove heap/object memory stuff.

Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>

* further ax a few extra stuff.

* remove runner.debug_str

Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>

* Update python/ray/tune/utils/resource_updater.py

Co-authored-by: Kai Fricke <krfricke@users.noreply.github.com>
Signed-off-by: xwjiang2010 <87673679+xwjiang2010@users.noreply.github.com>

* Update python/ray/tune/utils/resource_updater.py

Co-authored-by: Kai Fricke <krfricke@users.noreply.github.com>
Signed-off-by: xwjiang2010 <87673679+xwjiang2010@users.noreply.github.com>

---------

Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>
Signed-off-by: xwjiang2010 <87673679+xwjiang2010@users.noreply.github.com>
Co-authored-by: Kai Fricke <krfricke@users.noreply.github.com>
Signed-off-by: elliottower <elliot@elliottower.com>
ProjectsByJackHe pushed a commit to ProjectsByJackHe/ray that referenced this pull request May 4, 2023
…#33312)

* [air output] Update wording to "Logical Resource Usage".

Update wording to "Logical Resource Usage" and remove heap/object memory stuff.

Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>

* further ax a few extra stuff.

* remove runner.debug_str

Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>

* Update python/ray/tune/utils/resource_updater.py

Co-authored-by: Kai Fricke <krfricke@users.noreply.github.com>
Signed-off-by: xwjiang2010 <87673679+xwjiang2010@users.noreply.github.com>

* Update python/ray/tune/utils/resource_updater.py

Co-authored-by: Kai Fricke <krfricke@users.noreply.github.com>
Signed-off-by: xwjiang2010 <87673679+xwjiang2010@users.noreply.github.com>

---------

Signed-off-by: xwjiang2010 <xwjiang2010@gmail.com>
Signed-off-by: xwjiang2010 <87673679+xwjiang2010@users.noreply.github.com>
Co-authored-by: Kai Fricke <krfricke@users.noreply.github.com>
Signed-off-by: Jack He <jackhe2345@gmail.com>
@xwjiang2010 xwjiang2010 deleted the tune_output_resources branch July 26, 2023 19:55
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.

3 participants