Skip to content

Commit 622715c

Browse files
committed
Minor doc string update to parmest.py
1 parent 1251c5b commit 622715c

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

pyomo/contrib/parmest/parmest.py

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -326,15 +326,15 @@ def _check_model_labels_helper(model, logging_level):
326326

327327
def _get_labeled_model_helper(experiment):
328328
"""
329-
Returns the annotated Pyomo model
329+
Returns the annotated Pyomo model from the Experiment class
330330
331331
Parameters
332332
----------
333333
experiment : class
334334
Estimator class object that contains the Pyomo model
335335
for a particular experimental condition
336336
"""
337-
# checks if the Experiment class has a "get_labeled_model" function
337+
# check if the Experiment class has a "get_labeled_model" function
338338
get_model = getattr(experiment, "get_labeled_model", None)
339339
if not callable(get_model):
340340
raise AttributeError(
@@ -1754,15 +1754,17 @@ def cov_est(self, method="finite_difference", solver="ipopt", step=1e-3):
17541754
"""
17551755
Covariance matrix calculation using all scenarios in the data
17561756
1757+
Parameters
1758+
----------
17571759
method : str, optional
1758-
Covariance calculation method specified by the user,
1759-
options - 'finite_difference', 'reduced_hessian',
1760-
and 'automatic_differentiation_kaug'
1760+
Covariance calculation method. Options - 'finite_difference',
1761+
'reduced_hessian', and 'automatic_differentiation_kaug'.
1762+
Default is 'finite_difference'
17611763
solver : str, optional
1762-
Solver name specified by the user, e.g., 'ipopt'
1764+
Solver name, e.g., 'ipopt'. Default is 'ipopt'
17631765
step : float, optional
17641766
Float used for relative perturbation of the parameters,
1765-
e.g., step=0.02 is a 2% perturbation
1767+
e.g., step=0.02 is a 2% perturbation. Default is 1e-3
17661768
17671769
Returns
17681770
-------

0 commit comments

Comments
 (0)