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.

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

Already on GitHub? Sign in to your account

Create mapping of pyttb-TTB functionality #180

Open
dmdunla opened this issue Jul 6, 2023 · 6 comments
Open

Create mapping of pyttb-TTB functionality #180

dmdunla opened this issue Jul 6, 2023 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation doing Actively being worked on
Milestone

Comments

@dmdunla
Copy link
Collaborator

dmdunla commented Jul 6, 2023

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

@dmdunla dmdunla added this to the v2.0 milestone Jul 6, 2023
@dmdunla dmdunla added the documentation Improvements or additions to documentation label Jul 6, 2023
@ntjohnson1
Copy link
Collaborator

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
Copy link
Collaborator Author

dmdunla commented Jul 6, 2023

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.

@jeremy-myers jeremy-myers self-assigned this Sep 27, 2023
@jeremy-myers jeremy-myers added the doing Actively being worked on label Sep 27, 2023
@dmdunla
Copy link
Collaborator Author

dmdunla commented Sep 27, 2023

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
Copy link
Collaborator

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
Copy link
Collaborator

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

@ntjohnson1
Copy link
Collaborator

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation doing Actively being worked on
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

3 participants