search

sandialabs / pyttb

Python Tensor Toolbox
https://pyttb.readthedocs.io
BSD 2-Clause "Simplified" License
21 stars 13 forks source link

Create mapping of pyttb-TTB functionality #180

Open dmdunla opened 1 year ago

dmdunla commented 1 year ago

To assist transitions from the Tensor Toolbox for MATLAB to pyttb, create some reference documentation of the mapping of methods and any important differences.

ntjohnson1 commented 1 year ago

I believe https://github.com/sandialabs/pyttb/wiki/Development-Plans already has moderate coverage here (in case this wasn't already what you were thinking about).

dmdunla commented 1 year ago

Yes, I was going to start from there (which is incomplete) and then consider moving it to RTD as a new section.

We're past the original intent of dev plans, but this will provide the basis for the MATLAB->pyttb mappings.

dmdunla commented 1 year ago

This is related to:

As part of the RTD docs, I suggest we add a subsection of Getting Started called, "pyttb for MATLAB Users"

ntjohnson1 commented 11 months ago

I saw @jeremy-myers started to work on this already by writing up tables in restructured text (which looks great so far!). I would really like something that fails loudly when we continue to updated pyttb and potentially diverge from the MATLAB. We could probably setup the MATLAB getting started stuff as Jupyter notebooks rendered to our read the docs as well. Then if we change and interface that breaks it won't be allowed to check in. There are probably other ways.

Alternatively I think we can just add doctests to sphinx/RST if we think that would be easier. I'm not sure if the ability to interact with a jupyter notebook is as relevant for users coming from MATLAB.

jeremy-myers commented 11 months ago

I've been quiet the last few weeks but expect to see some commits ones this PR this upcoming week.

ntjohnson1 commented 11 months ago

Zero rush on my side. I was on a variety of flights this week so I was much more active. Just wanted to weigh in to reduce a large refactor after this was 100% complete.