Skip to content

Commit

Permalink
Update ThetaCriterionPCE.py
Browse files Browse the repository at this point in the history
Added description of optional parameter
  • Loading branch information
NovakLBUT authored Apr 21, 2023
1 parent 441e35b commit e33a673
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions src/UQpy/sampling/ThetaCriterionPCE.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit e33a673

Please sign in to comment.