Skip to content

Commit

Permalink
update docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
paquiteau committed Feb 2, 2022
1 parent 6f8f0b0 commit 68f23c0
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion modopt/opt/proximity.py
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,8 @@ class LowRankMatrix(ProximityParent):
lowr_type : {'standard', 'ngole'}
Low-rank implementation (options are 'standard' or 'ngole', default is
'standard')
initial_rank: int, optional
Initial guess of the rank of future input_data. If provided this will save computation time.
operator : class
Operator class ('ngole' only)
Expand Down Expand Up @@ -293,7 +295,6 @@ def _op_method(self, input_data, extra_factor=1.0, rank=None):
extra_factor : float
Additional multiplication factor (default is ``1.0``)
rank: int, optional
An estimation of the rank to save computation in standard mode.
An estimation of the rank to save computation time in standard mode, if not set an internal estimation is used.
Returns
Expand Down

0 comments on commit 68f23c0

Please sign in to comment.