diff --git a/README.md b/README.md index 67fb2ae18806fb0fb97ef154603082e28b451107..9b7e3b2826865dc537682ccf0acd66f9bfc6c7ee 100644 --- a/README.md +++ b/README.md @@ -43,8 +43,16 @@ The behavior can be finely controlled by passing additional keyword arguments to This is an up to date list of available keyword options: - - `nsteps`: integer parameter, number of steps to be used in the extrapolation. - **Note:** Calling `guess` before loading `nsteps` data points will cause a `ValueError`. + - `nsteps`: integer, default 6, number of steps to be used in the extrapolation. + - `verbose`: boolean, default False, if True print additional information. + - `descriptor`: string, default "distance", possible options are "distance" and "coulomb". + - `fitting`: string, default "leastsquare", possible options are "leastsquare" and "qtr". + - `allow_partially_filled`: bool, default True. If True allow to do a guess before `nsteps` data points have been loaded, if False asking for a guess before `nsteps` data points will cause a `ValueError`. + - `store_overlap`: bool, default True. Store the overlaps for later usage in calling guess without passing the current overlap. It can be disabled for performance, but calling guess will require passing the overlap. + +Some options can be piped to the fitting modules. + - `fitting_regularization`: float, default 0.0. Controls the regularization for both the "leastsquare" and "qtr" fitting schemes. + ## Acknowledgments