Skip to content

Nick/create problem #442

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

Open
wants to merge 20 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 8 additions & 3 deletions .github/workflows/regression-tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ jobs:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version: ["3.9", "3.10", "3.11", "3.12"]
matrix: # Keep these in ascending order for automagic with coverage
python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]

steps:
- uses: actions/checkout@v4
Expand All @@ -32,13 +32,18 @@ jobs:
python -c "import pyttb"
- name: Install dev dependencies
run: |
python -m pip install --upgrade coverage coveralls sphinx_rtd_theme
python -m pip install --upgrade coverage sphinx_rtd_theme
pip install ".[dev]"
- name: Run tests
run: |
coverage run --source pyttb -m pytest tests/
coverage report
- name: Add coveralls dependencies
if: strategy.job-index == 0
run: |
python -m pip install --upgrade coveralls
- name: Upload coverage to Coveralls
if: strategy.job-index == 0
uses: coverallsapp/github-action@v2
#env:
# GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
Expand Down
34 changes: 34 additions & 0 deletions docs/source/create_problem.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
Create Test Problems (:obj:`pyttb.create_problem`)
---------------------------------------------------

.. autofunction:: pyttb.create_problem.create_problem

.. autoclass:: pyttb.create_problem.BaseProblem
:exclude-members: __dict__, __weakref__, __slots__
:show-inheritance:

.. autoclass:: pyttb.create_problem.CPProblem
:exclude-members: __dict__, __weakref__, __slots__
:show-inheritance:

.. autoclass:: pyttb.create_problem.TuckerProblem
:exclude-members: __dict__, __weakref__, __slots__
:show-inheritance:

.. autoclass:: pyttb.create_problem.ExistingSolution
:exclude-members: __dict__, __weakref__, __slots__
:show-inheritance:

.. autoclass:: pyttb.create_problem.ExistingCPSolution
:exclude-members: __dict__, __weakref__, __slots__
:show-inheritance:

.. autoclass:: pyttb.create_problem.ExistingTuckerSolution
:exclude-members: __dict__, __weakref__, __slots__
:show-inheritance:

.. autoclass:: pyttb.create_problem.MissingData
:members:
:special-members:
:exclude-members: __dict__, __weakref__, __slots__
:show-inheritance:
5 changes: 5 additions & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,13 @@ algorithms for computing low-rank tensor models.
decompositions such as Poisson Tensor Factorization via alternating
Poisson regression.

- `IO`_

Storing and retrieving tensors from disk.

.. _Tensor Classes: tensor_classes.html
.. _Algorithms: algorithms.html
.. _IO: io.html


Getting Started
Expand Down
6 changes: 6 additions & 0 deletions docs/source/io.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Input/Output
------------
Storing or reading tensors from disk.

.. autofunction:: pyttb.import_data.import_data
.. autofunction:: pyttb.export_data.export_data
4 changes: 4 additions & 0 deletions docs/source/matlab/additional_support.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Additional Utilities For MATLAB User Transition
-----------------------------------------------

.. autofunction:: pyttb.matlab.matlab_support.matlab_print
8 changes: 0 additions & 8 deletions docs/source/matlab/symktensor.rst

This file was deleted.

8 changes: 0 additions & 8 deletions docs/source/matlab/symtensor.rst

This file was deleted.

6 changes: 4 additions & 2 deletions docs/source/pyttb_utils.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
Helper Functions (:mod:`pyttb_utils`)
-------------------------------------
Helper Functions (:mod:`pyttb_utils`, :mod:`khatrirao`)
--------------------------------------------------------

.. autofunction:: pyttb.khatrirao.khatrirao

.. automodule:: pyttb.pyttb_utils
:members:
Expand Down
1 change: 1 addition & 0 deletions docs/source/reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,4 @@ Reference (:mod:`pyttb`)

tensor_classes.rst
algorithms.rst
io.rst
1 change: 1 addition & 0 deletions docs/source/tensor_classes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,5 @@ Tensor Classes
tenmat.rst
sptenmat.rst
pyttb_utils.rst
create_problem.rst

Loading
Loading