docs: add mention and example for type coercion#1572
Merged
Conversation
Signed-off-by: Tanguy Abel <tanguy.abel@gmail.com>
Tanguyabel
force-pushed
the
docs-type-coercion
branch
from
2527122 to
8c196d3
Compare
samsja
requested changes
May 24, 2023
samsja
left a comment
samsja
left a comment
Member
There was a problem hiding this comment.
looks good.
Tho readme is not the right section for this.
IMO the best would be that you put it in a Tensor section here : https://docs.docarray.org/data_types/first_steps/
Contributor
Author
@samsja I understand what you say. I added the mention there because:
Any suggestion? |
makram93
reviewed
May 24, 2023
makram93
left a comment
makram93
left a comment
Contributor
There was a problem hiding this comment.
should we also highlight type coercion to AnyTensor in this doc?
Member
|
Then lets move it to the BaseDoc section at the end. I don't think we should overload the readme |
Member
|
merging into my pr because I am taking over this to add it into my new Tensor section |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This PR brings changes to the docs where we mention type coercion for Tensor, with an example.