From e5179ffe8bf72d5fd498035afeee364006f59843 Mon Sep 17 00:00:00 2001 From: Geoff Pleiss <824157+gpleiss@users.noreply.github.com> Date: Wed, 3 Jul 2024 01:47:00 +0200 Subject: [PATCH] Fix errors in docs (#96) - 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 --- docs/source/linear_operator.rst | 1 - linear_operator/operators/_linear_operator.py | 4 +++- setup.py | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/source/linear_operator.rst b/docs/source/linear_operator.rst index e84c9536..069a802b 100644 --- a/docs/source/linear_operator.rst +++ b/docs/source/linear_operator.rst @@ -6,4 +6,3 @@ LinearOperator .. autoclass:: linear_operator.LinearOperator :members: - :noindex: linear_operator.operators diff --git a/linear_operator/operators/_linear_operator.py b/linear_operator/operators/_linear_operator.py index 5e06d5d6..f89e806d 100644 --- a/linear_operator/operators/_linear_operator.py +++ b/linear_operator/operators/_linear_operator.py @@ -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. @@ -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 @@ -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 diff --git a/setup.py b/setup.py index 0fa7de65..ce191bda 100644 --- a/setup.py +++ b/setup.py @@ -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"], },