Skip to content

Commit 0a6942d

Browse files
committed
Use negative intergers for no stop
1 parent 60ebf13 commit 0a6942d

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

pydmd/bopdmd.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -81,11 +81,11 @@ class BOPDMDOperator(DMDOperator):
8181
:type mode_prox: function
8282
:param bag_warning: Number of consecutive non-converged trials of BOP-DMD
8383
at which to produce a warning message for the user. Default is 100.
84-
Use arguments less than or equal to zero for no warning condition.
84+
Use arguments less than zero for no warning condition.
8585
:type bag_warning: int
8686
:param bag_maxfail: Number of consecutive non-converged trials of BOP-DMD
8787
at which to terminate the fit. Default is 100. Use arguments less than
88-
or equal to zero for no stopping condition.
88+
zero for no stopping condition.
8989
:type bag_maxfail: int
9090
:param init_lambda: Initial value used for the regularization parameter in
9191
the Levenberg method. Default is 1.0.
@@ -977,11 +977,11 @@ class BOPDMD(DMDBase):
977977
:type mode_prox: function
978978
:param bag_warning: Number of consecutive non-converged trials of BOP-DMD
979979
at which to produce a warning message for the user. Default is 100.
980-
Use arguments less than or equal to zero for no warning condition.
980+
Use arguments less than zero for no warning condition.
981981
:type bag_warning: int
982982
:param bag_maxfail: Number of consecutive non-converged trials of BOP-DMD
983983
at which to terminate the fit. Default is 100. Use arguments less than
984-
or equal to zero for no stopping condition.
984+
zero for no stopping condition.
985985
:type bag_maxfail: int
986986
:param varpro_opts_dict: Dictionary containing the desired parameter values
987987
for variable projection. The following parameters may be specified:
@@ -1021,7 +1021,7 @@ def __init__(
10211021
if not isinstance(bag_warning, int) or not isinstance(bag_maxfail, int):
10221022
msg = (
10231023
"bag_warning and bag_maxfail must be integers. "
1024-
"Please use a non-positive integer if no warning "
1024+
"Please use a negative integer if no warning "
10251025
"or stopping condition is desired."
10261026
)
10271027
raise TypeError(msg)

0 commit comments

Comments
 (0)