-
Notifications
You must be signed in to change notification settings - Fork 5.8k
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
[docs] fix build #34265
[docs] fix build #34265
Changes from 5 commits
a9570e2
0dd1824
4865111
fcb7dff
7bcd081
e26928a
8be7df8
0d62127
0fb941d
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -149,3 +149,17 @@ Serialization | |
Dataset.has_serializable_lineage | ||
Dataset.serialize_lineage | ||
Dataset.deserialize_lineage | ||
|
||
|
||
Internals | ||
--------- | ||
|
||
.. autosummary:: | ||
:toctree: doc/ | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Oh cool, this deprecates most of my fix PR here: #34228 Btw, is there a way to hide this internals section by default? Some of these are legacy backwards compatibility aliases that we don't want to expose. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @ericl yes, toctrees can be |
||
|
||
Dataset.__init__ | ||
Dataset.dataset_format | ||
Dataset.fully_executed | ||
Dataset.is_fully_executed | ||
Dataset.lazy | ||
Dataset.write_webdataset | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This one should be added to "I/O and Conversion" list in dataset.rst |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -191,22 +191,6 @@ class ExecutionOptions: | |
"""Common options for execution. | ||
|
||
Some options may not be supported on all executors (e.g., resource limits). | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I was able to fix this via adding the nosummary template: https://github.com/ray-project/ray/pull/34228/files#diff-b3a1d55836e0b2035d287e569a716fa02296221b15eee9babd6c2ea0f62a2ec7R13 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. cool, thanks There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. @pcmoritz you can undo this particular diff now (fixed in master). There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks, will do! |
||
Attributes: | ||
resource_limits: Set a soft limit on the resource usage during execution. | ||
This is not supported in bulk execution mode. Autodetected by default. | ||
locality_with_output: Set this to prefer running tasks on the same node as the | ||
output node (node driving the execution). It can also be set to a list of | ||
node ids to spread the outputs across those nodes. Off by default. | ||
preserve_order: Set this to preserve the ordering between blocks processed by | ||
operators under the streaming executor. The bulk executor always preserves | ||
order. Off by default. | ||
actor_locality_enabled: Whether to enable locality-aware task dispatch to | ||
actors (on by default). This applies to both ActorPoolStrategy map and | ||
streaming_split operations. | ||
verbose_progress: Whether to report progress individually per operator. By | ||
default, only AllToAll operators and global progress is reported. This | ||
option is useful for performance debugging. Off by default. | ||
""" | ||
|
||
resource_limits: ExecutionResources = ExecutionResources() | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We need these to be explicitly in a TOC somewhere. We can argue about the exact position after fixing the build.