Skip to content

Commit

Permalink
Add inherited field in docstring of child classes
Browse files Browse the repository at this point in the history
  • Loading branch information
runame committed Dec 16, 2024
1 parent b7ea5f6 commit 20400d0
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion matrix_functions_types.py
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,8 @@ class EigenConfig(RootInvConfig, EigenvalueDecompositionConfig):
"""Configuration for eigendecomposition (`_matrix_inverse_root_eigen`) method.
Args:
retry_double_precision (bool): Whether to re-trying eigendecomposition with higher (double) precision if lower precision fails due
to CuSOLVER failure. (Default: True)
make_positive_semidefinite (bool): Perturbs matrix eigenvalues to ensure it is numerically positive semi-definite. (Default: True)
exponent_multiplier (float): Number to be multiplied to the numerator of the inverse root, i.e., eta where the
exponent is -eta / (2 * p). (Default: 1.0)
Expand Down Expand Up @@ -97,7 +99,13 @@ class EigenvectorConfig(MatrixFunctionConfig):

@dataclass(kw_only=True)
class EighEigenvectorConfig(EigenvectorConfig, EigenvalueDecompositionConfig):
"""Configuration for eigenvectors via eigendecomposition (`_compute_eigenvectors_eigh`) method."""
"""Configuration for eigenvectors via eigendecomposition (`_compute_eigenvectors_eigh`) method.
Args:
retry_double_precision (bool): Whether to re-trying eigendecomposition with higher (double) precision if lower precision fails due
to CuSOLVER failure. (Default: True)
"""


DefaultEighEigenvectorConfig = EighEigenvectorConfig()
Expand Down

0 comments on commit 20400d0

Please sign in to comment.