Skip to content

Commit

Permalink
Fix errors in docs (#96)
Browse files Browse the repository at this point in the history
- Fix building issue due to error in uncompyle6 3.9.1 (lock down version)
- LinearOperator is included in the doc inventory (for automatic
  references)
- Small change to LinearOperator#cat_rows
  • Loading branch information
gpleiss authored Jul 2, 2024
1 parent a0a9c42 commit e5179ff
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 3 deletions.
1 change: 0 additions & 1 deletion docs/source/linear_operator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,3 @@ LinearOperator

.. autoclass:: linear_operator.LinearOperator
:members:
:noindex: linear_operator.operators
4 changes: 3 additions & 1 deletion linear_operator/operators/_linear_operator.py
Original file line number Diff line number Diff line change
Expand Up @@ -1154,7 +1154,7 @@ def cat_rows(
generate_roots: bool = True,
generate_inv_roots: bool = True,
**root_decomp_kwargs,
) -> Float[LinearOperator, "*batch M+O N+O"]:
) -> Float[LinearOperator, "... M+O N+O"]:
r"""
Concatenates new rows and columns to the matrix that this LinearOperator represents, e.g.
Expand All @@ -1177,6 +1177,7 @@ def cat_rows(
To update :math:`\mathbf R`, we first update :math:`\mathbf L`:
.. math::
\begin{bmatrix}
\mathbf A & \mathbf B^\top \\
\mathbf B & \mathbf D
Expand All @@ -1194,6 +1195,7 @@ def cat_rows(
Solving this matrix equation, we get:
.. math::
\mathbf A &= \mathbf{EE}^\top = \mathbf{LL}^\top \quad (\Rightarrow \mathbf E = L) \\
\mathbf B &= \mathbf{EF}^\top \quad (\Rightarrow \mathbf F = \mathbf{BR}) \\
\mathbf D &= \mathbf{FF}^\top + \mathbf{GG}^\top
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ def find_version(*file_paths):
"six",
"sphinx_rtd_theme",
"sphinx-autodoc-typehints",
"uncompyle6",
"uncompyle6<=3.9.0",
],
"test": ["flake8==5.0.4", "flake8-print==5.0.0", "pytest"],
},
Expand Down

0 comments on commit e5179ff

Please sign in to comment.