Skip to content

Commit

Permalink
DOC: minor bug fixes in sparselm_estimators.py docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
qchempku2017 committed Sep 16, 2023
1 parent a2d2e97 commit d678912
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions WFacer/utils/sparselm_estimators.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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.
Expand Down

0 comments on commit d678912

Please sign in to comment.