Skip to content

Commit

Permalink
Very minor updates to the documentation for Chatterjee Sensitivity do…
Browse files Browse the repository at this point in the history
…cumentation
  • Loading branch information
mds2120 committed Oct 20, 2022
1 parent ec2f910 commit b82e53e
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/source/sensitivity/chatterjee.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ The :class:`.ChatterjeeSensitivity` class is imported using the following comman
Methods
"""""""
.. autoclass:: UQpy.sensitivity.ChatterjeeSensitivity
:members: run, compute_chatterjee_indices, rank_analog_to_pickfreeze, compute_Sobol_indices
:members: run, compute_chatterjee_indices, rank_analog_to_pickfreeze, rank_analog_to_pickfreeze_vec, compute_Sobol_indices

Attributes
""""""""""
Expand Down
4 changes: 3 additions & 1 deletion src/UQpy/sensitivity/ChatterjeeSensitivity.py
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,9 @@ def run(
confidence_level: PositiveFloat = 0.95,
):
"""
Compute the sensitivity indices using the Chatterjee method.
Compute the sensitivity indices using the Chatterjee method. Employing the :code:`run` method will initialize
:code:`n_samples` simulations using :class:`.RunModel`. To compute sensitivity indices using pre-computed inputs
and outputs, use the static methods described below.
:param n_samples: Number of samples used to compute the Chatterjee indices. \
Default is 1,000.
Expand Down

0 comments on commit b82e53e

Please sign in to comment.