[Feature] [Performance] [Docs] Disabling object spilling is not documented
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- python
- Domain
- distributed-systems, documentation
Research direction
Start with the object-spilling configuration documentation and the automatic_object_spilling_enabled definition in src/ray/common/ray_config_def.h. Confirm whether the RAY_automatic_object_spilling_enabled environment variable or the corresponding configuration setting is the supported way to disable spilling. Done means the documentation clearly describes the guaranteed configuration and its limitations.
Written by the indexing model from the issue text.
Description
Search before asking
- I had searched in the issues and found no similar feature requirement.
Description
Object spilling is a useful feature of Ray. However, certain use cases require the object spilling to be disabled and the way to do so is not obvious whatsoever.
Disabling object spilling is not even mentioned in the docs, which describe only the ways of configuring object spilling and specifying its configuration.
From an investigation of the source code, it seems like setting the environment variable RAY_automatic_object_spilling_enabled to false (or otherwise specifying automatic_object_spilling_enabled to false) should be sufficient (https://github.com/ray-project/ray/blob/619478331240612f408a90a445bb3dea56d13696/src/ray/common/ray_config_def.h#L391). It is however unclear whether this is a preferred or guaranteed way to disable spilling.
Can we please look to explicitly describe how to disable object spilling in the docs?
Use case
There are use cases for Ray where spilling objects onto disk might cause errors or simply not be an option for security reasons. A clearly defined way to disable object spilling can improve feasibility of Ray in high-security applications.
Related issues
No response
Are you willing to submit a PR?
- Yes I am willing to submit a PR!
- Dominant language
- Python
- Stars
- 43.9k
- Forks
- 8.1k
- Avg merge
- 4d 12h
- Merged PRs (30d)
- 234
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from ray-project/ray
-
community-backlog core stability
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
ray-project/ray#66333 ·
-
community-backlog core stability
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
ray-project/ray#66331 ·
-
[core][gcs] HandleUnregisterNode does not reply when the node is already removed, hanging the raylet Opencommunity-backlog core stability
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
ray-project/ray#66329 ·
-
[Serve][Docs] In-place updates guide doesn't mention that code-update replica restarts are rolling Opencommunity-backlog docs serve usability
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
ray-project/ray#66265 ·
-
community-backlog core docs stability usability
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
ray-project/ray#66114 · 1 comment ·
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
bancolombia/sentinel#23 ·
-
test md OpenCI
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
integration:quickjs org:external priority:backlog topic:code-interpreter topic:middleware type:feature
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
langchain-ai/deepagents#6450 ·
-
bug client
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100