[Datasets] Improve to_tf docstring
#29464
Merged
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
Co-authored-by: Clark Zinzow <[email protected]> Signed-off-by: Balaji Veeramani <[email protected]>
bveeramani
requested review from
ericl,
scv119,
clarkzinzow,
jjyao,
jianoaix and
c21
as code owners
bveeramani
commented
Oct 19, 2022
bveeramani
commented
Oct 19, 2022
clarkzinzow
reviewed
Oct 19, 2022
python/ray/data/dataset.py
Outdated
Comment on lines
2840
to
2842
| If your dataset contains ragged tensors, this method errors. To prevent | ||
| errors, resize tensors or | ||
| :ref:`disable tensor extension casting <disable_tensor_extension_casting>`. |
There was a problem hiding this comment.
The only blocker for this is that schema inference breaks for ragged tensors; IMO we should provide an optional output_signature argument that bypasses schema inference (I think this is a generically good thing to have), at which point ragged tensors would currently be supported via specifying an output_signature with the appropriate ragged tensor spec.
disable tensor extension casting
For .to_tf(), I don't think that ragged tensors will work, even with tensor extension casting disabled. I think the only route is resizing the tensors.
There was a problem hiding this comment.
#29476 adds support for ragged tensors and removes this warning.
Signed-off-by: Balaji Veeramani <[email protected]>
WeichenXu123
pushed a commit
to WeichenXu123/ray
that referenced
this pull request
Dec 19, 2022
The `Dataset.to_tf` docstring is out-of-date, and it doesn't contain examples. This PR updates the docstring content and adds docstring examples. Signed-off-by: Balaji Veeramani <[email protected]> Co-authored-by: Clark Zinzow <[email protected]> Signed-off-by: Weichen Xu <[email protected]>
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.
Signed-off-by: Balaji [email protected]
Depends on:
strexclude#29443Why are these changes needed?
The
Dataset.to_tfdocstring is out-of-date, and it doesn't contain examples. This PR updates the docstring content and adds docstring examples.Related issue number
See #29028
Closes #29202
Checks
git commit -s) in this PR.scripts/format.shto lint the changes in this PR.