voiage.metamodels.Metamodel

A protocol for metamodels used in VOI analysis.

Methods

fit

fit([positional or keyword] self: None = None, [positional or keyword] x: ParameterSet = None, [positional or keyword] y: np.ndarray = None) -> None

Fit the metamodel to the data.

Parameters

x : ParameterSet The input parameters. y : np.ndarray The target values.

Parameters:

• self
• x ParameterSet
• y np.ndarray

Returns: None

predict

predict([positional or keyword] self: None = None, [positional or keyword] x: ParameterSet = None) -> np.ndarray

Predict the target values for the given input parameters.

Parameters

x : ParameterSet The input parameters.

Returns

np.ndarray The predicted target values.

Parameters:

• self
• x ParameterSet

Returns: np.ndarray

score

score([positional or keyword] self: None = None, [positional or keyword] x: ParameterSet = None, [positional or keyword] y: np.ndarray = None) -> float

Return the coefficient of determination R^2 of the prediction.

Parameters

x : ParameterSet The input parameters. y : np.ndarray The true target values.

Returns

float R^2 score.

Parameters:

• self
• x ParameterSet
• y np.ndarray

Returns: float

rmse

rmse([positional or keyword] self: None = None, [positional or keyword] x: ParameterSet = None, [positional or keyword] y: np.ndarray = None) -> float

Return the root mean squared error of the prediction.

Parameters

x : ParameterSet The input parameters. y : np.ndarray The true target values.

Returns

float RMSE score.

Parameters:

• self
• x ParameterSet
• y np.ndarray

Returns: float