[Data][Docs] Standardize from_items API ref
#36432
Merged
+19
−9
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
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
Signed-off-by: Balaji Veeramani <balaji@anyscale.com>
raulchen
reviewed
Jun 21, 2023
| @@ -103,23 +103,33 @@ def from_items( | |||
| parallelism: int = -1, | |||
| output_arrow_format: bool = True, | |||
| ) -> MaterializedDataset: | |||
| """Create a dataset from a list of local Python objects. | |||
| """Create a :class:`~ray.data.Dataset` from a list of local Python objects. | |||
There was a problem hiding this comment.
just curious. how do you verify whether the link to Dataset is correct?
There was a problem hiding this comment.
You'd have to render the documentation locally (make develop) or check the ReadTheDocs CI build.
raulchen
approved these changes
Jun 21, 2023
raulchen
reviewed
Jun 21, 2023
| .. testcode:: | ||
|
|
||
| import ray | ||
|
|
There was a problem hiding this comment.
nit, these blank lines are not necessary, right? Look a bit too verbose.
There was a problem hiding this comment.
The blankline before import ray isn't rendered. Included a blankline after imports because that's conventional, but I guess that isn't strictly necessary.
amogkam
approved these changes
Jun 21, 2023
8 tasks
arvind-chandra
pushed a commit
to lmco/ray
that referenced
this pull request
Aug 31, 2023
This PR standardizes the from_items API reference in accordance with the broader standardization effort. --------- Signed-off-by: Balaji Veeramani <balaji@anyscale.com> Signed-off-by: e428265 <arvind.chandramouli@lmco.com>
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?
This PR standardizes the
from_itemsAPI reference in accordance with the broader standardization effort.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.