rc.gsa.models

User interface for undertaking GSA on a MOGP

Classes

GSA	Class encapsulating a generic Sobol calculation.
Sobol	Class encapsulating a generic Sobol calculation.

Module Contents

class GSA(gp, kind, m=-1, is_error_calculated=False, **kwargs)

Bases: rc.base.models.DataBase

Class encapsulating a generic Sobol calculation.

Parameters:

• gp (GPR)

• kind (GSA)

• m (int)

• is_error_calculated (bool)

• kwargs (rc.base.definitions.Any)

class Kind

Bases: enum.IntEnum

Enum to specify the kind of Sobol index to calculate.

property calibrator: Calibrator

Abstractmethod:

Return type:

Calibrator

The object to do the calculations, whose marginalise(m) method returns a dict of results.

calibrate(method=None, **kwargs)

Perform a generic GSA calculation. This method should be overriden by specific subclasses, and called via super() as a matter of priority.

Parameters:

method (str) – Not used.

Return type:

rc.base.definitions.Dict[str, rc.base.definitions.Any]

Returns: The results of the calculation, as a labelled dictionary of tf.Tensors.

meta

The Meta currently in self.

class Sobol(gp, kind, m=-1, is_error_calculated=False, **kwargs)

Bases: GSA

Class encapsulating a generic Sobol calculation.

Parameters:

• gp (GPR)

• kind (GSA)

• m (int)

• is_error_calculated (bool)

• kwargs (rc.base.definitions.Any)

class Data

Bases: rc.base.models.Tables

The Data set of a GSA.

property NamedTuple: rc.base.definitions.Type[rc.base.definitions.NamedTuple]

Classmethod:

Return type:

rc.base.definitions.Type[rc.base.definitions.NamedTuple]

The NamedTuple underpinning this Data set.

property META: rc.base.definitions.Dict[str, rc.base.definitions.Any]

Classmethod:

Return type:

rc.base.definitions.Dict[str, rc.base.definitions.Any]

Default calculation meta. is_T_partial forces WmM = 0.

property calibrator: ClosedSobol

The object to do the calculations, whose marginalise(m) method returns a dict of results. :param gp: The GPR underpinning the GSA. :param is_error_calculated: Whether to calculate the standard error of the GSA :param **kwargs: MetaData passed straight to the Calibrator.

Returns: The Calibrator.

Return type:

ClosedSobol