Documentation overhaul

Atemp.mtx

@@ -0,0 +1,23 @@
+matrix
+2
+5 4
+1.0000000000000000e+00
+6.0000000000000000e+00
+1.1000000000000000e+01
+1.6000000000000000e+01
+2.0000000000000000e+00
+7.0000000000000000e+00
+1.2000000000000000e+01
+1.7000000000000000e+01
+3.0000000000000000e+00
+8.0000000000000000e+00
+1.3000000000000000e+01
+1.8000000000000000e+01
+4.0000000000000000e+00
+9.0000000000000000e+00
+1.4000000000000000e+01
+1.9000000000000000e+01
+5.0000000000000000e+00
+1.0000000000000000e+01
+1.5000000000000000e+01
+2.0000000000000000e+01

CONTRIBUTING.md

@@ -76,7 +76,7 @@ current or filing a new [issue](https://github.com/sandialabs/pyttb/issues).
    ```
       1. For the CI version which is more strict
       ```commandline
-      sphinx-build ./docs/source ./docs/build -W -n --keep-going
+      sphinx-build ./docs/source ./docs/build -E -W --keep-going
       ```
       2. If not on Windows optionally add `-j auto` for parallelization
    2. Clear notebook outputs if run locally see `nbstripout` in our [pre-commit configuration](.pre-commit-config.yaml)

Ktemp.tns

@@ -0,0 +1,26 @@
+ktensor
+3
+5 4 3
+2
+1.0000000000000000e+00 1.0000000000000000e+00
+matrix
+2
+5 2
+1.0000000000000000e+00 6.0000000000000000e+00
+2.0000000000000000e+00 7.0000000000000000e+00
+3.0000000000000000e+00 8.0000000000000000e+00
+4.0000000000000000e+00 9.0000000000000000e+00
+5.0000000000000000e+00 1.0000000000000000e+01
+matrix
+2
+4 2
+1.0000000000000000e+00 5.0000000000000000e+00
+2.0000000000000000e+00 6.0000000000000000e+00
+3.0000000000000000e+00 7.0000000000000000e+00
+4.0000000000000000e+00 8.0000000000000000e+00
+matrix
+2
+3 2
+1.0000000000000000e+00 4.0000000000000000e+00
+2.0000000000000000e+00 5.0000000000000000e+00
+3.0000000000000000e+00 6.0000000000000000e+00

Ttemps.tns

@@ -0,0 +1,63 @@
+tensor
+3
+3 4 5
+2.4313567236808464e-01
+8.5461744740975198e-01
+4.7075829812164127e-01
+4.2353756119620134e-01
+1.0809034164312792e-01
+2.1343236316591530e-01
+8.5903831396461416e-01
+7.1766748043247763e-01
+5.4911648502816746e-01
+4.1056038109268744e-01
+1.4811092697982420e-01
+8.3249584750236127e-01
+1.0121943083605089e-01
+9.7508795425127137e-01
+3.2216902851253792e-01
+9.3173977031640864e-01
+1.0383386811897577e-01
+9.2861648393714524e-01
+8.1416258911849548e-01
+7.0798320371456391e-02
+5.1434957568763429e-01
+7.5637552873427727e-01
+6.4449482686655946e-01
+9.4240027822025030e-01
+6.1353965709566283e-01
+7.2064416484485094e-01
+2.1790465309932883e-01
+2.3804789082290456e-01
+9.4523655339031210e-01
+4.7692482053634855e-02
+6.6796875897810104e-01
+4.4208307334537400e-02
+5.4493817437709080e-01
+2.2222558358093836e-01
+6.5748454188029049e-01
+3.8686062626499940e-01
+4.3879610723962370e-01
+7.4589963733585618e-03
+6.3797267253995427e-01
+6.9602079511880577e-02
+5.7579815120471067e-01
+8.9216605249320491e-01
+1.6293235001713857e-01
+7.7003190987734860e-01
+7.2973922571523331e-01
+4.4292734840430104e-01
+5.4163473219816638e-01
+9.5545208091364964e-01
+1.7967933562544913e-01
+1.3367078192317039e-01
+4.8051761768530332e-01
+4.2048793075932145e-01
+4.6862170808474413e-01
+7.1053768046252053e-01
+2.0714109593530705e-02
+4.5485897754916493e-01
+8.4330193211606341e-01
+6.8253074577361383e-01
+2.2654173766977470e-01
+8.1469028482006889e-01

docs/source/cpals.rst

@@ -1,8 +1,13 @@
-CP Alternating Least Squares (:obj:`cp_als`)
-============================================
+CP Alternating Least Squares (:obj:`pyttb.cp_als`)
+==================================================
 .. note::
 
-     The ``cp_als`` function defined in ``cp_als.py`` has been promoted to the ``pyttb`` namespace.
+    Functions defined in ``cp_als.py`` have been promoted to the ``pyttb`` namespace.
+
+For *all* examples in this document, the following module imports are assumed::
+
+    >>> import pyttb as ttb
+    >>> import numpy as np
 
 .. autofunction:: pyttb.cp_als
 

docs/source/cpapr.rst

@@ -1,8 +1,13 @@
-CP Alternating Poisson Regression (:obj:`cp_apr`)
-=================================================
+CP Alternating Poisson Regression (:obj:`pyttb.cp_apr`)
+=======================================================
 .. note::
 
-     The ``cp_apr`` function defined in ``cp_apr.py`` has been promoted to the ``pyttb`` namespace.
+     Functions defined in ``cp_apr.py`` have been promoted to the ``pyttb`` namespace.
+
+For *all* examples in this document, the following module imports are assumed::
+
+    >>> import pyttb as ttb
+    >>> import numpy as np
 
 .. autofunction:: pyttb.cp_apr
 

docs/source/gcpopt.rst

@@ -2,7 +2,12 @@ Generalized CP Optimization (:obj:`pyttb.gcp_opt`)
 ==================================================
 .. note::
 
-     The ``gcp_opt`` function defined in ``gcp_opt.py`` has been promoted to the ``pyttb`` namespace.
+     Functions defined in ``gcp_optor.py`` have been promoted to the ``pyttb`` namespace.
+
+For *all* examples in this document, the following module imports are assumed::
+
+    >>> import pyttb as ttb
+    >>> import numpy as np
 
 .. autofunction:: pyttb.gcp_opt
 

docs/source/hosvd.rst

@@ -1,8 +1,12 @@
-Tucker Higher-Order SVD (:obj:`hosvd`)
-======================================
+Tucker Higher-Order SVD (:obj:`pyttb.hosvd`)
+============================================
 .. note::
 
-     The ``hosvd`` function defined in ``hosvd.py`` has been promoted to the ``pyttb`` namespace.
+    Functions defined in ``hosvd.py`` have been promoted to the ``pyttb`` namespace.
 
+For *all* examples in this document, the following module imports are assumed::
+
+    >>> import pyttb as ttb
+    >>> import numpy as np
 
 .. autofunction:: pyttb.hosvd

docs/source/ktensor.rst

@@ -1,8 +1,13 @@
-Kruskal Tensor (:class:`ktensor`)
----------------------------------
+Kruskal Tensor (:class:`pyttb.ktensor`)
+=======================================
 .. note::
 
-     The ``ktensor`` class defined in ``ktensor.py`` has been promoted to the ``pyttb`` namespace.
+     Classes and functions defined in ``ktensor.py`` have been promoted to the ``pyttb`` namespace.
+
+For *all* examples in this document, the following module imports are assumed::
+
+    >>> import pyttb as ttb
+    >>> import numpy as np
 
 .. autoclass:: pyttb.ktensor
     :members:

docs/source/pyttb_utils.rst

@@ -1,10 +1,10 @@
-Helper Functions (:mod:`pyttb_utils`, :mod:`khatrirao`)
---------------------------------------------------------
-
-.. autofunction:: pyttb.khatrirao.khatrirao
+Helper Functions (:mod:`pyttb.pyttb_utils`, :mod:`pyttb.khatrirao`)
+===================================================================
 
 .. automodule:: pyttb.pyttb_utils
     :members:
     :special-members:
     :exclude-members: __dict__, __weakref__, __slots__
-    :show-inheritance:
+    :show-inheritance:
+
+.. autofunction:: pyttb.khatrirao.khatrirao

docs/source/sptenmat.rst

@@ -1,8 +1,13 @@
-Sparse Tensor as Matrix (:class:`sptenmat`)
--------------------------------------------
+Sparse Tensor as Matrix (:class:`pyttb.sptenmat`)
+=================================================
 .. note::
 
-     The ``sptenmat`` class defined in ``sptenmat.py`` has been promoted to the ``pyttb`` namespace.
+     Classes and functions defined in ``sptenmat.py`` have been promoted to the ``pyttb`` namespace.
+
+For *all* examples in this document, the following module imports are assumed::
+
+    >>> import pyttb as ttb
+    >>> import numpy as np
 
 .. autoclass:: pyttb.sptenmat
     :members:

docs/source/sptensor.rst

@@ -1,13 +1,18 @@
-Sparse Tensor (:class:`sptensor`)
----------------------------------
+Sparse Tensor (:class:`pyttb.sptensor`)
+=======================================
 .. note::
 
      Classes and functions defined in ``sptensor.py`` have been promoted to the ``pyttb`` namespace.
 
+For *all* examples in this document, the following module imports are assumed::
+
+    >>> import pyttb as ttb
+    >>> import numpy as np
+
 .. autoclass:: pyttb.sptensor
     :members:
     :special-members:
-    :exclude-members: __dict__, __weakref__, __slots__
+    :exclude-members: __dict__, __weakref__, __slots__, __deepcopy__
     :show-inheritance:
 
 .. autofunction:: pyttb.sptenrand

docs/source/sumtensor.rst

@@ -1,9 +1,13 @@
-Sum Tensor (:class:`sumtensor`)
--------------------------------
+Sum Tensor (:class:`pyttb.sumtensor`)
+=====================================
 .. note::
 
-     The ``sumtensor`` class defined in ``sumtensor.py`` has been promoted to the ``pyttb`` namespace.
+     Classes and functions defined in ``sumtensor.py`` have been promoted to the ``pyttb`` namespace.
 
+For *all* examples in this document, the following module imports are assumed::
+
+    >>> import pyttb as ttb
+    >>> import numpy as np
 
 .. autoclass:: pyttb.sumtensor
     :members:

docs/source/tenmat.rst

@@ -1,8 +1,13 @@
-Tensor as Matrix (:class:`tenmat`)
-----------------------------------
+Tensor as Matrix (:class:`pyttb.tenmat`)
+========================================
 .. note::
 
-     The ``tenmat`` class defined in ``tenmat.py`` has been promoted to the ``pyttb`` namespace.
+     Classes and functions defined in ``tenmat.py`` have been promoted to the ``pyttb`` namespace.
+
+For *all* examples in this document, the following module imports are assumed::
+
+    >>> import pyttb as ttb
+    >>> import numpy as np
 
 .. autoclass:: pyttb.tenmat
     :members:

docs/source/tensor.rst

@@ -1,22 +1,19 @@
 Dense Tensor (:class:`pyttb.tensor`)
-------------------------------------
-.. note::
-
-     Classes and functions defined in ``tensor.py`` have been promoted to the ``pyttb`` namespace.
+====================================
 
-For *all* examples in this document, the following module imports are assumed::
+For *all* examples in this document, the following imports are assumed::
 
     >>> import pyttb as ttb
     >>> import numpy as np
 
-.. automodule:: pyttb.tensor
+.. autoclass:: pyttb.tensor
     :members:
     :special-members:
-    :exclude-members: __dict__, __weakref__, __slots__, __deepcopy__
+    :exclude-members: __init__, __dict__, __weakref__, __deepcopy__
     :show-inheritance:
 
-.. autofunction:: pyttb.tenones
-.. autofunction:: pyttb.tenzeros
-.. autofunction:: pyttb.tenrand
 .. autofunction:: pyttb.tendiag
 .. autofunction:: pyttb.teneye
+.. autofunction:: pyttb.tenones
+.. autofunction:: pyttb.tenrand
+.. autofunction:: pyttb.tenzeros

docs/source/ttensor.rst

@@ -2,7 +2,7 @@ Tucker tensor (:class:`pyttb.ttensor`)
 --------------------------------------
 .. note::
 
-     The ``ttensor`` class defined in ``ttensor.py`` has been promoted to the ``pyttb`` namespace.
+     Classes and functions defined in ``sptensor.py`` have been promoted to the ``pyttb`` namespace.
 
 .. autoclass:: pyttb.ttensor
     :members:

docs/source/tuckerals.rst

@@ -2,6 +2,11 @@ Tucker Alternating Least Squares (:obj:`pyttb.tucker_als`)
 ==========================================================
 .. note::
 
-     The ``tucker_als`` function defined in ``tucker_als.py`` has been promoted to the ``pyttb`` namespace.
+     Functions defined in ``tucker_als.py`` have been promoted to the ``pyttb`` namespace.
+
+For *all* examples in this document, the following module imports are assumed::
+
+    >>> import pyttb as ttb
+    >>> import numpy as np
 
 .. autofunction:: pyttb.tucker_als