From e33a67385e04131fcca1f2605c6838fc19d63d9c Mon Sep 17 00:00:00 2001 From: Lukas Novak <95358264+NovakLBUT@users.noreply.github.com> Date: Fri, 21 Apr 2023 20:39:34 +0200 Subject: [PATCH] Update ThetaCriterionPCE.py Added description of optional parameter --- src/UQpy/sampling/ThetaCriterionPCE.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/UQpy/sampling/ThetaCriterionPCE.py b/src/UQpy/sampling/ThetaCriterionPCE.py index da732c51..f91dda46 100644 --- a/src/UQpy/sampling/ThetaCriterionPCE.py +++ b/src/UQpy/sampling/ThetaCriterionPCE.py @@ -28,6 +28,8 @@ def run(self, existing_samples: np.ndarray, candidate_samples: np.ndarray, nsamp :param candidate_weights: Weights associated to candidate samples (e.g. from Coherence Sampling). :param nsamples: Number of samples selected from candidate set in a single run of this algorithm :param pce_weights: Weights associated to each PCE (e.g. Eigen values from dimension-reduction techniques) + :param enable_criterium: If True, values of Theta criterion (variance density, average variance density, geometrical part, total Theta criterion) for all + candidates are returned instead of a positions of best candidates The :meth:`run` method is the function that performs iterations in the :class:`.ThetaCriterionPCE` class. The :meth:`run` method of the :class:`.ThetaCriterionPCE` class can be invoked many times for sequential sampling.