MetaModelValidationResult

class persalys.MetaModelValidationResult(*args)

Create the base class for the results of a metamodel validation.

Methods

getClassName(self)

Accessor to the object’s name.

getId(self)

Accessor to the object’s id.

getMetaModelOutputSample(self)

Output sample accessor.

getName(self)

Validation method name accessor.

getQ2(self)

Q2 accessor.

getResiduals(self)

Residuals accessor.

getShadowedId(self)

Accessor to the object’s shadowed id.

getVisibility(self)

Accessor to the object’s visibility state.

hasName(self)

Test if the object is named.

hasVisibleName(self)

Test if the object has a distinguishable name.

setName(self, name)

Accessor to the object’s name.

setShadowedId(self, id)

Accessor to the object’s shadowed id.

setVisibility(self, visible)

Accessor to the object’s visibility state.

__init__(self, *args)

Initialize self. See help(type(self)) for accurate signature.

getClassName(self)

Accessor to the object’s name.

Returns
class_namestr

The object class name (object.__class__.__name__).

getId(self)

Accessor to the object’s id.

Returns
idint

Internal unique identifier.

getMetaModelOutputSample(self)

Output sample accessor.

Returns
sampleopenturns.Sample

Output sample evaluated with the metamodel

getName(self)

Validation method name accessor.

Returns
namestr

Validation method name

getQ2(self)

Q2 accessor.

Returns
q2openturns.Point

The predictive squared correlation coefficient Q2 is defined as follows for each output of the model: 1 - \displaystyle \frac{\sum_{i=1}^N (y_i - \hat{y_i})^2}{(N-1) {\rm Var}\left[ \underline{Y} \right]} with \underline{Y} the vector of the N model’s values y_i and \hat{y_i} the prediction.

getResiduals(self)

Residuals accessor.

Returns
erroropenturns.Point

The errors are defined as follows for each output of the model: \displaystyle \frac{\sqrt{\sum_{i=1}^N (y_i - \hat{y_i})^2}}{N} with y_i the N model’s values and \hat{y_i} the prediction.

getShadowedId(self)

Accessor to the object’s shadowed id.

Returns
idint

Internal unique identifier.

getVisibility(self)

Accessor to the object’s visibility state.

Returns
visiblebool

Visibility flag.

hasName(self)

Test if the object is named.

Returns
hasNamebool

True if the name is not empty.

hasVisibleName(self)

Test if the object has a distinguishable name.

Returns
hasVisibleNamebool

True if the name is not empty and not the default one.

setName(self, name)

Accessor to the object’s name.

Parameters
namestr

The name of the object.

setShadowedId(self, id)

Accessor to the object’s shadowed id.

Parameters
idint

Internal unique identifier.

setVisibility(self, visible)

Accessor to the object’s visibility state.

Parameters
visiblebool

Visibility flag.