[Core] Improve doc for --object-store-memory to describe how the default value is set #45301
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ue is set Signed-off-by: Jiajun Yao <jeromeyjj@gmail.com>
ruisearch42
approved these changes
May 13, 2024
| object store with. By default, this is automatically set based on | ||
| available system memory. | ||
| object store with. | ||
| By default, this is 30% of available system memory capped by the shm size. |
There was a problem hiding this comment.
The logic to compute the default is a bit involved. Do you want to refer the readers to ResourceSpec.resolve() or at least mention ray_constants.DEFAULT_OBJECT_STORE_MEMORY_PROPORTION as pointers?
| @@ -367,7 +367,7 @@ def debug(address): | |||
| required=False, | |||
| type=int, | |||
| help="The amount of memory (in bytes) to start the object store with. " | |||
| "By default, this is capped at 20GB but can be set higher.", | |||
| "By default, this is 30% of available system memory capped by the shm size.", | |||
There was a problem hiding this comment.
Do you want to mention the caps like DEFAULT_OBJECT_STORE_MAX_MEMORY_BYTES and DEFAULT_OBJECT_STORE_MAX_MEMORY_BYTES as well?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Why are these changes needed?
Currently it's unclear how the default value is set
Related issue number
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.method in Tune, I've added it in
doc/source/tune/api/under thecorresponding
.rstfile.