Skip to content

Draft: Doc update #374

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

Draft
wants to merge 36 commits into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
9eba56d
Internal: Try new link checker
ntjohnson1 Dec 14, 2024
fd1bf91
Internal: Add codespell and fix typos.
ntjohnson1 Dec 14, 2024
87ea5f5
Internal: See if codespell precommit finds config.
ntjohnson1 Dec 14, 2024
244069e
Internal: Found config. Now enable reading it
ntjohnson1 Dec 14, 2024
81ed5fe
MATLAB: Add initial support for more matlab support.
ntjohnson1 Dec 14, 2024
b8e183b
DEV: Updating contributing doc for more details on adding a tutorial
ntjohnson1 Dec 17, 2024
1526f4c
Fix internal calls to avoid fortran warnings in tutorials
ntjohnson1 Dec 20, 2024
8c84a01
Update one tutorial with "F" order to avoid warnings.
ntjohnson1 Dec 20, 2024
5d94cac
Various documentation updates, on top of Nick's Fortran fixes.
tgkolda Dec 27, 2024
c3d6728
Fighting with the tensor class.
tgkolda Dec 29, 2024
8e26de2
Continuing to work on documentation to make it match TensorToolbox.
tgkolda Dec 30, 2024
eb5d8e3
Had to put quotes around some arguments for file names that have a sp…
tgkolda Dec 30, 2024
2848253
Fixing tests to match updates error messages.
tgkolda Dec 30, 2024
b62e011
Merge remote-tracking branch 'remotes/tgkolda/test_quote_fix' into tg…
tgkolda Dec 30, 2024
5c24317
Resolving various errors from checks.
tgkolda Dec 30, 2024
d3c2d2e
Extra fix related to #378.
tgkolda Dec 30, 2024
97d2229
More fixes to pass tests.
tgkolda Dec 30, 2024
f6c8de7
Fixes one of the many problems caused by #368. Just create an array o…
tgkolda Dec 30, 2024
f0e40ed
Make it so that from_function works with np.random.
tgkolda Dec 31, 2024
d127d65
Adding a comment about the (current) requirement of Fortran ordering.
tgkolda Dec 31, 2024
e60a2a7
Adding help to show how to use from_function to work with randn.
tgkolda Dec 31, 2024
d4d378e
Better solution for #380 and also #368. The function isn't changed bu…
tgkolda Dec 31, 2024
023346f
Being more consistent with periods and language.
tgkolda Dec 31, 2024
a5ca9be
More documentation cleaning.
tgkolda Dec 31, 2024
38655fc
Aligning docs more with original docs. Adding stuff specific to Pytho…
tgkolda Dec 31, 2024
54e3eb4
Linking to tutorial.
tgkolda Dec 31, 2024
327acaf
Fixing spacing to satisfy tests.
tgkolda Dec 31, 2024
cc899bf
Rearrange order of tensor classes
tgkolda Dec 31, 2024
deca97d
Making sure methods are also included in documentation.
tgkolda Dec 31, 2024
b2b15a5
Updating comments and avoiding asfortranarray call for tenrand. Parti…
tgkolda Dec 31, 2024
5f9c0f7
Working more on the documentation.
tgkolda Dec 31, 2024
a0d08d7
Adding more explanation about __deepcopy__ per #381.
tgkolda Jan 2, 2025
aa3bd96
Removing type and minor rewording so that it's clear what True/False …
tgkolda Jan 2, 2025
130d95a
Updates to tensor tutorial.
tgkolda Jan 31, 2025
b987f02
Merge remote-tracking branch 'remotes/origin/main' into doc-update
tgkolda Jan 31, 2025
50fef5d
Merge branch 'doc-update' of github.com:tgkolda/pyttb into tgkolda-do…
tgkolda Jan 31, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ dist/
tests/__pycache__
pyttb/__pycache__
build/
_build/
.coverage
.ipynb_checkpoints
htmlcov
Expand Down
13 changes: 11 additions & 2 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,25 @@ pyttb: Python Tensor Toolbox
****************************
Tensors (also known as multidimensional arrays or N-way arrays) are used
in a variety of applications ranging from chemometrics to network
analysis.
analysis. This Python package is an adaptation of the
`Tensor Toolbox for MATLAB <https://www.tensortoolbox.org>`_.

- Install the latest release from pypi (``pip install pyttb``).
- This is open source software. Please see `LICENSE`_ for the
terms of the license (2-clause BSD).
- For more information or for feedback on this project, please `contact us`_.

.. _`LICENSE`: ../../../LICENSE
.. _contact us: #contact

Installing
==========

* Via pypi
- Install the latest release from pypi (``pip install pyttb``).
* From source
- Clone the repository from `github <https://github.com/sandialabs/pyttb>`_.
- Install the package with ``pip install .`` from the pyttb root directory.

Functionality
==============
pyttb provides the following classes and functions
Expand Down
4 changes: 2 additions & 2 deletions docs/source/tensor.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
pyttb.tensor
--------------------

.. autoclass:: pyttb.tensor
.. automodule:: pyttb.tensor
:members:
:special-members:
:exclude-members: __dict__, __weakref__, __slots__, __init__
:exclude-members: __dict__, __weakref__, __slots__, __init__, mttv_left, mttv_mid, mttv_right, min_split
:show-inheritance:
18 changes: 9 additions & 9 deletions docs/source/tensor_classes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@ Tensor Classes
==============

.. toctree::
:maxdepth: 2
:maxdepth: 3

ktensor.rst
sptenmat.rst
sptensor.rst
sumtensor.rst
tensor.rst
ttensor.rst
tenmat.rst
pyttb_utils.rst
tensor
sptensor
ktensor
ttensor
sumtensor
tenmat
sptenmat
pyttb_utils

Loading
Loading