Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

UQResults: Add docstrings for undocumented attributes #360

Merged
merged 2 commits into from
Aug 3, 2022
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 17 additions & 2 deletions deerlab/classes.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,19 +87,34 @@ class UQResult:
type : string
Uncertainty quantification approach:

* 'covariance' - Covariance-based uncertainty analysis
* 'bootstrap' - Bootstrapped uncertainty analysis
* ``'covariance'`` - Covariance-based uncertainty analysis
* ``'bootstrap'`` - Bootstrapped uncertainty analysis
* ``'profile'`` - Likelihood profile uncertainty analysis
* ``'void'`` - Empty uncertainty analysis

mean : ndarray
Mean values of the uncertainty distribution of the parameters.

median : ndarray
Median values of the uncertainty distribution of the parameters.

std : ndarray
Standard deviations of the uncertainty distribution of the parameters.

covmat : ndarray
Covariance matrix

nparam : int scalar
Number of parameters in the analysis.

samples : ndarray
Bootstrap samples of the parameters. Only available for ``type='bootstrap'``.

profile : ndarray
Likelihood profile of the parameters. Only available for ``type='profile'``.

threshold : scalar
Treshold value used for the profile method. Only available for ``type='profile'``.

Methods
-------
Expand Down