Base Model Classes

Base classes shared by all model wrappers.

class modeva.models.ModelBaseRegressor

Base Class for Modeva Regressors.

calibrate_interval(X, y, alpha=0.1, max_depth: int = 5)

Fit a conformal prediction model to the given data.

This method computes the model’s prediction interval calibrated to the given data.

If the model is a regressor, splits the data with 50% for fitting lower (alpha / 5) and upper (1 - alpha / 2) gradient boosting trees-based quantile regression to the model’s residual; and 50% for calibration.

If the model is a binary classifiers, it computes the calibration quantile based on predicted probabilities for the positive class.

Parameters:

XXnp.ndarray of shape (n_samples, n_features)

Feature matrix for prediction.

yarray-like of shape (n_samples, )

Target values.

alphafloat, default=0.1

Expected miscoverage for the conformal prediction.

max_depthint, default=5

Maximum depth of the gradient boosting trees for regression tasks. Only used when task_type is REGRESSION.

Raises:

ValueError: If the model is neither a regressor nor a classifier.

get_metadata_routing()

Get metadata routing of this object.

Please check User Guide on how the routing mechanism works.

Returns:

routingMetadataRequest

A MetadataRequest encapsulating routing information.

get_params(deep=True)

Get parameters for this estimator.

Parameters:

deepbool, default=True

If True, will return the parameters for this estimator and contained subobjects that are estimators.

Returns:

paramsdict

Parameter names mapped to their values.

load(file_name: str)

Load the model into memory from file system.

Parameters:

file_name: str

The path and name of the file.

Returns:

estimator object

predict(X)

Model predictions, calling the child class’s ‘_predict’ method.

Parameters:

Xnp.ndarray of shape (n_samples, n_features)

Feature matrix for prediction.

Returns:

np.ndarray: The (calibrated) final prediction

predict_interval(X)

Predict the prediction interval for the given data based on the conformal prediction model.

It splits the data with 50% for fitting lower (alpha / 5) and upper (1 - alpha / 2) gradient boosting trees-based quantile regression to the model’s residual; and 50% for calibration.

Parameters:

Xnp.ndarray of shape (n_samples, n_features)

Feature matrix for prediction.

Returns:

np.ndarray: The lower and upper bounds of the prediction intervals for each sample

in the format [n_samples, 2] for regressors or a flattened array for classifiers.

Raises:

ValueError: If fit_conformal has not been called to fit the conformal prediction model

before calling this method.

reset_calibrate_interval()

reset_calibrate_proba()

save(file_name: str)

Save the model into file system.

Parameters:

file_name: str

The path and name of the file.

set_params(**params)

Set the parameters of this estimator.

The method works on simple estimators as well as on nested objects (such as Pipeline). The latter have parameters of the form <component>__<parameter> so that it’s possible to update each component of a nested object.

Parameters:

**paramsdict

Estimator parameters.

Returns:

selfestimator instance

Estimator instance.

property name

property version

class modeva.models.ModelBaseClassifier

Base Class for Modeva Classifiers.

calibrate_interval(X, y, alpha=0.1)

Fit a conformal prediction model to the given data.

This method computes the model’s prediction interval calibrated to the given data.

It computes the calibration quantile based on predicted probabilities for the positive class.

Parameters:

XXnp.ndarray of shape (n_samples, n_features)

Feature matrix for prediction.

yarray-like of shape (n_samples, )

Target values.

alphafloat, default=0.1

Expected miscoverage for the conformal prediction.

Raises:

ValueError: If the model is neither a regressor nor a classifier.

calibrate_proba(X, y, sample_weight=None, method='sigmoid')

Fit the calibration method on the model’s predictions.

Parameters:

Xnp.ndarray of shape (n_samples, n_features)

Feature matrix for prediction.

ynp.ndarray of shape (n_samples, )

Ground truth labels.

sample_weightarray-like, shape (n_samples,), default=None

Sample weights.

method{‘sigmoid’, ‘isotonic’}, default=’sigmoid’

The calibration method.

• ‘sigmoid’: Platt’s method, i.e., fit a logistic regression on predicted probabilities and y

• ‘isotonic’: Fit an isotonic regression on predicted probabilities and y.

Returns:

self: Calibrated estimator

decision_function(X, calibration: bool = True)

Computes the decision function for the given input data.

Parameters:

Xnp.ndarray of shape (n_samples, n_features)

Feature matrix for prediction.

calibrationbool, default=True

If True, will use calibrated probability if calibration is done. Otherwise, will use raw probability.

Returns:

logit_predictionarray, shape (n_samples,) or (n_samples, n_classes)

Array of (calibrated) logit predictions.

get_metadata_routing()

Get metadata routing of this object.

Please check User Guide on how the routing mechanism works.

Returns:

routingMetadataRequest

A MetadataRequest encapsulating routing information.

get_params(deep=True)

Get parameters for this estimator.

Parameters:

deepbool, default=True

If True, will return the parameters for this estimator and contained subobjects that are estimators.

Returns:

paramsdict

Parameter names mapped to their values.

load(file_name: str)

Load the model into memory from file system.

Parameters:

file_name: str

The path and name of the file.

Returns:

estimator object

predict(X, calibration: bool = True)

Model predictions, calling the child class’s ‘_predict’ method.

Parameters:

Xnp.ndarray of shape (n_samples, n_features)

Feature matrix for prediction.

calibrationbool, default=True

If True, will use calibrated probability if calibration is done. Otherwise, will use raw probability.

Returns:

np.ndarray: The (calibrated) final prediction

predict_interval(X)

Predict the prediction set for the given data based on the conformal prediction model.

This method computes the model prediction interval (regression) or prediction sets (classification) using conformal prediction.

Parameters:

Xnp.ndarray of shape (n_samples, n_features)

Feature matrix for prediction.

Returns:

np.ndarray: The lower and upper bounds of the prediction intervals for each sample

in the format [n_samples, 2] for regressors or a flattened array for classifiers.

Raises:

ValueError: If fit_conformal has not been called to fit the conformal prediction model

before calling this method.

predict_proba(X, calibration: bool = True)

Predict (calibrated) probabilities for X.

Parameters:

Xnp.ndarray of shape (n_samples, n_features)

Feature matrix for prediction.

calibrationbool, default=True

If True, will return calibrated probability if calibration is done. Otherwise, will return raw probability.

Returns:

np.ndarray: The (calibrated) predicted probabilities

reset_calibrate_interval()

reset_calibrate_proba()

save(file_name: str)

Save the model into file system.

Parameters:

file_name: str

The path and name of the file.

set_decision_function_request(*, calibration: bool | None | str = '$UNCHANGED$') → ModelBaseClassifier

Request metadata passed to the decision_function method.

Note that this method is only relevant if enable_metadata_routing=True (see sklearn.set_config()). Please see User Guide on how the routing mechanism works.

The options for each parameter are:

• True: metadata is requested, and passed to decision_function if provided. The request is ignored if metadata is not provided.

• False: metadata is not requested and the meta-estimator will not pass it to decision_function.

• None: metadata is not requested, and the meta-estimator will raise an error if the user provides it.

• str: metadata should be passed to the meta-estimator with this given alias instead of the original name.

The default (sklearn.utils.metadata_routing.UNCHANGED) retains the existing request. This allows you to change the request for some parameters and not others.

Added in version 1.3.

Note

This method is only relevant if this estimator is used as a sub-estimator of a meta-estimator, e.g. used inside a Pipeline. Otherwise it has no effect.

Parameters:

calibrationstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED

Metadata routing for calibration parameter in decision_function.

Returns:

selfobject

The updated object.

set_params(**params)

Set the parameters of this estimator.

The method works on simple estimators as well as on nested objects (such as Pipeline). The latter have parameters of the form <component>__<parameter> so that it’s possible to update each component of a nested object.

Parameters:

**paramsdict

Estimator parameters.

Returns:

selfestimator instance

Estimator instance.

set_predict_proba_request(*, calibration: bool | None | str = '$UNCHANGED$') → ModelBaseClassifier

Request metadata passed to the predict_proba method.

Note that this method is only relevant if enable_metadata_routing=True (see sklearn.set_config()). Please see User Guide on how the routing mechanism works.

The options for each parameter are:

• True: metadata is requested, and passed to predict_proba if provided. The request is ignored if metadata is not provided.

• False: metadata is not requested and the meta-estimator will not pass it to predict_proba.

• None: metadata is not requested, and the meta-estimator will raise an error if the user provides it.

• str: metadata should be passed to the meta-estimator with this given alias instead of the original name.

The default (sklearn.utils.metadata_routing.UNCHANGED) retains the existing request. This allows you to change the request for some parameters and not others.

Added in version 1.3.

Note

This method is only relevant if this estimator is used as a sub-estimator of a meta-estimator, e.g. used inside a Pipeline. Otherwise it has no effect.

Parameters:

calibrationstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED

Metadata routing for calibration parameter in predict_proba.

Returns:

selfobject

The updated object.

set_predict_request(*, calibration: bool | None | str = '$UNCHANGED$') → ModelBaseClassifier

Request metadata passed to the predict method.

Note that this method is only relevant if enable_metadata_routing=True (see sklearn.set_config()). Please see User Guide on how the routing mechanism works.

The options for each parameter are:

• True: metadata is requested, and passed to predict if provided. The request is ignored if metadata is not provided.

• False: metadata is not requested and the meta-estimator will not pass it to predict.

• None: metadata is not requested, and the meta-estimator will raise an error if the user provides it.

• str: metadata should be passed to the meta-estimator with this given alias instead of the original name.

The default (sklearn.utils.metadata_routing.UNCHANGED) retains the existing request. This allows you to change the request for some parameters and not others.

Added in version 1.3.

Note

This method is only relevant if this estimator is used as a sub-estimator of a meta-estimator, e.g. used inside a Pipeline. Otherwise it has no effect.

Parameters:

calibrationstr, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED

Metadata routing for calibration parameter in predict.

Returns:

selfobject

The updated object.

property name

property version