Skip to content

Commit 6949e81

Browse files
committed
improved docstring, hadn't said what padding does at the optimizer level
1 parent 0a5ea09 commit 6949e81

1 file changed

Lines changed: 2 additions & 2 deletions

File tree

pynumdiff/optimize/_optimize.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,8 +135,8 @@ def optimize(func, x, dt, search_space={}, dxdt_truth=None, tvgamma=1e-2, paddin
135135
:param float tvgamma: Only used if :code:`dxdt_truth` is given. Regularization value used to select for parameters
136136
that yield a smooth derivative. Larger value results in a smoother derivative.
137137
:param int padding: number of time steps to ignore at the beginning and end of the time series in the
138-
optimization. Larger value causes the optimization to emphasize the accuracy of dxdt in the
139-
middle of the time series
138+
optimization, or :code:`'auto'` to ignore 2.5% at each end. Larger value causes the
139+
optimization to emphasize the accuracy of dxdt in the middle of the time series
140140
:param str metric: either :code:`'rmse'` or :code:`'error_correlation'`, only applies if :code:`dxdt_truth`
141141
is not None, see _objective_function
142142
:param str opt_method: Optimization technique used by :code:`scipy.minimize`, the workhorse

0 commit comments

Comments
 (0)