21 sptensor complete documentation for all methods #219
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
* Starting docs * Docstrings through constructors. Fixing blankline in tensor.__str__. Aligning docstrings across classes. * Through contract * Through innerprod * Completed docstring updates. * Updating class docs to autoclass. * FIxing black formatting.
…github.com:sandialabs/pyttb into 21-sptensor-complete-documentation-for-all-methods
…github.com:sandialabs/pyttb into 21-sptensor-complete-documentation-for-all-methods
…github.com:sandialabs/pyttb into 21-sptensor-complete-documentation-for-all-methods
Co-authored-by: Nick <[email protected]>
Co-authored-by: Nick <[email protected]>
Co-authored-by: Nick <[email protected]>
Co-authored-by: Nick <[email protected]>
Co-authored-by: Nick <[email protected]>
Co-authored-by: Nick <[email protected]>
Co-authored-by: Nick <[email protected]>
Co-authored-by: Nick <[email protected]>
Co-authored-by: Nick <[email protected]>
Co-authored-by: Nick <[email protected]>
Co-authored-by: Nick <[email protected]>
Co-authored-by: Nick <[email protected]>
Co-authored-by: Nick <[email protected]>
Co-authored-by: Nick <[email protected]>
Co-authored-by: Nick <[email protected]>
Co-authored-by: Nick <[email protected]>
Co-authored-by: Nick <[email protected]>
Co-authored-by: Nick <[email protected]>
Co-authored-by: Nick <[email protected]>
Co-authored-by: Nick <[email protected]>
Co-authored-by: Nick <[email protected]>
Co-authored-by: Nick <[email protected]>
Co-authored-by: Nick <[email protected]>
Co-authored-by: Nick <[email protected]>
ntjohnson1
approved these changes
Nov 4, 2023
There was a problem hiding this comment.
This is everything I could find by a line review on the code and scrolling through the updated sptensor page on RTD. I think the only remaining thing besides the direct suggestions are the COMPARISON_ERROR and the changes to the logical_* methods. I'm fine if you want to merge this with those to filed as a follow up.
|
I got through most of your changes and suggestions. However, sptensor is more streamlined than the other methods, in terms of docs. This is an evolving process, so I may revisit those to help clean up while I’m on this kick. But sptensor took way more time than the other classes, so we’ll see.
I hope to merge today at some point.
|
…ce we use type hints.
dmdunla
deleted the
21-sptensor-complete-documentation-for-all-methods
branch
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.
Updating sptensor documentation.
📚 Documentation preview 📚: https://pyttb--219.org.readthedocs.build/en/219/