Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Nick/tenmat docs #294

Open
wants to merge 18 commits into
base: main
Choose a base branch
from
Open

Nick/tenmat docs #294

wants to merge 18 commits into from

Conversation

ntjohnson1
Copy link
Collaborator

@ntjohnson1 ntjohnson1 commented Dec 16, 2023 •
edited by github-actions bot
Loading

This branched off of the constructors PR to resolve tenmat documentation

  • I mostly just added examples everywhere and touched up some of the documentation if you wanted to review the generated docs (or that can be a follow up to propose clearer language).
  • I updated the profiling stuff to see if tenmat was actually a hotspot anywhere. It didn't seem to be a major bottleneck but that helped me find the redundant pyttb_utils I removed

馃摎 Documentation preview 馃摎: https://pyttb--294.org.readthedocs.build/en/294/

@ntjohnson1
Add copy constructor for tenmat.
e5d45ec
@ntjohnson1
SPTENMAT: Remove from_data. Merge with __init__
744e1cb
@ntjohnson1
SPTENMAT: Move from_tensor_type to to_sptenmat
f413df9 
* Add isequal
@ntjohnson1
Pull out some common code ahead of tenmat constructor refactor.
4220272
@ntjohnson1
TENMAT: Decouple from_data and from_tensor
fa4d029 
* From_data should only accept vector or matrix
@ntjohnson1
TENMAT: Merge from_data into default constructor
7abe49d
@ntjohnson1
TENMAT: Move from_tensor to to_tenmat
40ffa4b 
* Add isequal utility method to tenmat
@ntjohnson1
Update tutorials to match new constructors.
d16efd7
@ntjohnson1
Improve some documentation for updated constructors/methods.
8a04061
@ntjohnson1
BUILD: Temporarily pin ruff to unblock
8eebfa7
@ntjohnson1
TENMAT: Add doctest example for every method.
5e24ab8
@ntjohnson1
SPTENMAT: Add doctest example for every method.
1da704b
@ntjohnson1
TENMAT: Add copy argument to give option to try and optimize views.
5bf9895
@ntjohnson1
SPTENMAT: Add copy argument to give option to try and optimize views.
ae7ef78 
* Less critical for sparse tensors, so copy not added to to_sptenmat.
@ntjohnson1
PROFILING: Updating our profiling workflow.
9a12c93 
* Wanted to see if updating our algorithm calls to tenmat were worth optimizing
@ntjohnson1
TENMAT: Replace tt_to_dense_matrix usages with tenmat.
db20ae4
@ntjohnson1
TENMAT: Remove tt_from_dense_matrix since tenmat exists.
d2577d4
@ntjohnson1 ntjohnson1 marked this pull request as ready for review December 16, 2023 20:55
@ntjohnson1
Merge branch 'main' into nick/tenmat_docs
4f7bbcb 
# Conflicts:
#	pyttb/sptenmat.py
#	pyttb/tenmat.py
#	pyttb/tensor.py
#	tests/test_sptenmat.py
#	tests/test_tenmat.py
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dmdunla dmdunla Awaiting requested review from dmdunla

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

tenmat: complete documentation for all methods
1 participant
@ntjohnson1