From d678912e1a63c7f7981e556600fae486d80eb494 Mon Sep 17 00:00:00 2001 From: qchempku2017 Date: Fri, 15 Sep 2023 17:15:05 -0700 Subject: [PATCH] DOC: minor bug fixes in sparselm_estimators.py docs. --- WFacer/utils/sparselm_estimators.py | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/WFacer/utils/sparselm_estimators.py b/WFacer/utils/sparselm_estimators.py index 1450923..f617979 100644 --- a/WFacer/utils/sparselm_estimators.py +++ b/WFacer/utils/sparselm_estimators.py @@ -136,9 +136,9 @@ def prepare_estimator( Name of hyperparameter optimizer. Currently, only supports :class:`GridSearch` and :class:`LineSearch`. param_grid(dict|list[tuple]): - Parameter grid to initialize the optimizer. See docs of - :mod:`sparselm.model_selection`. - .. note:: Not needed when using :class:`OrdinaryLeastSquares`. + Parameter grid to initialize the optimizer. See docs of the + :mod:`sparselm.model_selection` module. + **Not needed when using** :class:`OrdinaryLeastSquares`. use_hierarchy(bool): optional Whether to use cluster hierarchy constraints when available. Default to true. @@ -153,8 +153,7 @@ def prepare_estimator( Other keyword arguments to initialize an optimizer. Returns: - GridSearchCV, LineSearchCV, StepwiseEstimator, - or OrdinaryLeastSquares: + Estimator: The estimator wrapped up for fitting. """ # Corrected and normalized DFT energy in eV/prim.