20 tensor complete documentation for all methods #218
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
…Aligning docstrings across classes.
dmdunla
merged commit 755eb4b
into
21-sptensor-complete-documentation-for-all-methods
5 checks passed
dmdunla
added a commit
that referenced
this pull request
Nov 5, 2023
* 20 tensor complete documentation for all methods (#218) * 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. * Start of docstring refactor. Aligning with tensor. * Adding doctest docs for constructors. * Black formatting. * More docstests. * Fixing save problem. * Doctest updates * Fixing message when incorrect shape is provided * Fixing sptensor.collapse * doc: Minor update * More doctest updates. * More doctest. Checkpoint. * logical_and doctest * Sptensor docstrings. Aligning with ktensor. * Black formatting * Adding doctest for updated mask. * Doctest through norm, aligning with ktensor * Doctest through reshape * Black formatting * Docstrings (cont). Align squeeze with changes in tensor. * ttv checkpoint * Fixing boolean values * TENSOR/SPTENSOR: Make squeeze consistent and correct * TENSOR/SPTENSOR: Hmm previous version worked locally. Try alternative approach to extract scalar from singleton array * Checkpoint hrough __getitem__ * More docstrings. * Fixing sptensor.__ne__. There are no tests for any of the __<foo>__ methods. * Black (again, ugh!) * Docstring checkpoint * Checkpoint * Fix doctest for contract * Starting to address extract. Need to open a new Issue before removing this, as it impacts the comparison operators in a non-trivial way. * Fix sptensor output in sumtensor doctest * Cleaning up some pytest dev marks and pre-commit docs. * sptensor coverage updates (extract skipped) * Coverage updates * Update CONTRIBUTING.md Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Update pyttb/sptensor.py Co-authored-by: Nick <[email protected]> * Fixing breaks from review. * Addressing reviews. Moving towards more brevity. Removing Returns since we use type hints. --------- Co-authored-by: Nick Johnson <[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.
Pulling in other doc updates.
📚 Documentation preview 📚: https://pyttb--218.org.readthedocs.build/en/218/