Sptensor clarification #137
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
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.
This is simpler solution to the confusion here #113 basically from_data does no validation but that is not explicit in the doc string so add the clarification. More broadly I know you discussed trying to unify our constructors so the user doesn't necessarily need to think about it. It is a little verbose that the
standardway to construct with validation isfrom_aggregator.Also while I was checking the generated doc I saw the warning that we've never actually linked in our bibtex
doc. We can probably provide a nicer sentence/cleanup but I figured it would be good to at least generate the set of references to original algorithms on our read the docs. It might be worth getting a fresh set of eyes from @DeepBlockDeepak on the read the docs to see what might make the documentation friendlier (probably overlaps with the tutorials and other efforts)