Merge branch 'main' into html-doc-depth

Author: dmdunla

docs/source/index.rst

@@ -4,16 +4,30 @@ 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. 
 
--  Install the latest release from pypi (``pip install pyttb``).
--  This is open source software. Please see `LICENSE`_ for the
+-  This Python package is an adaptation of the open source `Tensor Toolbox for MATLAB <https://www.tensortoolbox.org>`_.
+-  This is open source software. Please see `LICENSE <https://github.com/sandialabs/pyttb/blob/main/LICENSE>`_ for the
    terms of the license (2-clause BSD).
+-  The pyttb code repository is hosted at `github <https://github.com/sandialabs/pyttb>`_. 
+-  Contributions are welcome; see `CONTRIBUTING <https://github.com/sandialabs/pyttb/blob/main/CONTRIBUTING.md>`_.
+-  Reports of bugs and feature requests can be `submitted on github <https://github.com/sandialabs/pyttb/issues>`_.
 -  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`` or ``python -m 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. 
+   -  Note: Use ``pip install -e ".[dev,doc]"`` if you are planning development.
+
 Functionality
 ==============
 pyttb provides the following classes and functions

docs/source/sptensor.rst

@@ -1,7 +1,7 @@
 pyttb.sptensor
 ----------------------
 
-.. autoclass:: pyttb.sptensor
+.. automodule:: pyttb.sptensor
     :members:
     :special-members:
     :exclude-members: __dict__, __weakref__, __slots__, __init__

docs/source/tensor.rst

@@ -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:

pyttb/tensor.py

@@ -1391,7 +1391,6 @@ def symmetrize(  # noqa: PLR0912,PLR0915
             combos = []
             for i in range(0, ngrps):
                 combos.append(np.array(list(permutations(grps[i, :]))))
-            combos = np.stack(combos)
 
             # Create all the permutations to be averaged
             combo_lengths = [len(perm) for perm in combos]