From b82e53ee96030c234bf8fb599e6ea94435d41070 Mon Sep 17 00:00:00 2001 From: Michael Shields Date: Thu, 20 Oct 2022 14:14:49 -0400 Subject: [PATCH] Very minor updates to the documentation for Chatterjee Sensitivity documentation --- docs/source/sensitivity/chatterjee.rst | 2 +- src/UQpy/sensitivity/ChatterjeeSensitivity.py | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/source/sensitivity/chatterjee.rst b/docs/source/sensitivity/chatterjee.rst index bc2ccb6f..48d68a33 100644 --- a/docs/source/sensitivity/chatterjee.rst +++ b/docs/source/sensitivity/chatterjee.rst @@ -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 """""""""" diff --git a/src/UQpy/sensitivity/ChatterjeeSensitivity.py b/src/UQpy/sensitivity/ChatterjeeSensitivity.py index 99ab411b..9473a98e 100644 --- a/src/UQpy/sensitivity/ChatterjeeSensitivity.py +++ b/src/UQpy/sensitivity/ChatterjeeSensitivity.py @@ -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.