uqmodels.modelization package

Subpackages

• uqmodels.modelization.DL_estimator package
  • Submodules
  • uqmodels.modelization.DL_estimator.Lstm_WS_ED module
    • LSTM_ED_Generator
      • LSTM_ED_Generator.load()
      • LSTM_ED_Generator.on_epoch_end()
    • Lstm
      • Lstm.Build_generator()
      • Lstm.delete()
      • Lstm.factory()
      • Lstm.fit()
      • Lstm.get_params()
      • Lstm.load()
      • Lstm.model_initializer()
      • Lstm.modify_dropout()
      • Lstm.plot_metrics()
      • Lstm.predict()
      • Lstm.reset()
      • Lstm.save()
      • Lstm.set_fit_request()
      • Lstm.set_predict_request()
    • double_roll()
  • uqmodels.modelization.DL_estimator.baseline_models module
    • cnn_mlp()
  • uqmodels.modelization.DL_estimator.data_embedding module
    • Conv1D
    • Conv2D
    • DataEmbedding_ITS
      • DataEmbedding_ITS.call()
    • Data_embedding_TS
      • Data_embedding_TS.call()
    • Dropout
    • Factice_Time_Extension
      • Factice_Time_Extension.call()
      • Factice_Time_Extension.get_config()
    • FixedEmbedding
      • FixedEmbedding.call()
    • Mouving_Window_Embedding
      • Mouving_Window_Embedding.call()
    • Mouving_Windows_Embedding
      • Mouving_Windows_Embedding.call()
    • Mouving_conv_Embedding
      • Mouving_conv_Embedding.call()
      • Mouving_conv_Embedding.from_config()
      • Mouving_conv_Embedding.get_config()
    • PositionalEmbedding
      • PositionalEmbedding.call()
    • TemporalEmbedding
      • TemporalEmbedding.call()
    • ValuesEmbedding
      • ValuesEmbedding.call()
  • uqmodels.modelization.DL_estimator.loss module
    • BNN_loss_edl()
    • BNN_loss_gaussian()
    • BNN_metric_edl()
    • BNN_metric_gaussian()
    • build_BNN_loss()
    • build_CCE_loss()
    • build_EDL_loss()
    • build_MSE_loss()
    • default_callbacks()
  • uqmodels.modelization.DL_estimator.lstm_ed module
    • Lstm_ED_UQ
      • Lstm_ED_UQ.Build_generator()
      • Lstm_ED_UQ.factory()
      • Lstm_ED_UQ.set_fit_request()
      • Lstm_ED_UQ.set_predict_request()
    • build_lstm_stacked()
    • get_params_dict()
  • uqmodels.modelization.DL_estimator.metalayers module
    • Add_query_to_Z_Processing_with_state
      • Add_query_to_Z_Processing_with_state.call()
      • Add_query_to_Z_Processing_with_state.compute_output_shape()
    • Double_Moving_slice_layer
      • Double_Moving_slice_layer.build()
      • Double_Moving_slice_layer.call()
      • Double_Moving_slice_layer.compute_output_shape()
    • EDLProcessing
      • EDLProcessing.call()
      • EDLProcessing.compute_output_shape()
      • EDLProcessing.get_config()
    • LSTMCellMidsize
      • LSTMCellMidsize.build()
    • LSTMCellReturnCellState
      • LSTMCellReturnCellState.call()
    • LSTM_DProcessing()
    • LSTM_EProcessing()
    • Moving_slice_layer
      • Moving_slice_layer.build()
      • Moving_slice_layer.call()
      • Moving_slice_layer.compute_output_shape()
    • ProbabilisticProcessing
      • ProbabilisticProcessing.call()
      • ProbabilisticProcessing.compute_output_shape()
      • ProbabilisticProcessing.get_config()
    • RNN_states_in_inputs
      • RNN_states_in_inputs.call()
    • Tconv_block_1D()
    • Tconv_block_2D()
    • cnn_dec()
    • cnn_dec_1D()
    • cnn_dec_bis()
    • cnn_enc()
    • cnn_enc_1D()
    • cnn_enc_bis()
    • conv_block_1D()
    • conv_block_2D()
    • dense2D_enc_dec()
    • get_cnn_dec_params()
    • get_cnn_enc_params()
    • mlp()
    • moving_slice_map()
    • stack_and_roll_layer()
  • uqmodels.modelization.DL_estimator.neural_network_UQ module
    • Deterministic_prediction()
    • Drawn_based_prediction()
    • Ensemble_based_prediction()
    • Identity_factory()
    • NN_UQ
      • NN_UQ.Build_generator()
      • NN_UQ.basic_fit()
      • NN_UQ.basic_predict()
      • NN_UQ.build_loss()
      • NN_UQ.build_metrics()
      • NN_UQ.compile()
      • NN_UQ.dataset_generator()
      • NN_UQ.factory()
      • NN_UQ.fit()
      • NN_UQ.init_neural_network()
      • NN_UQ.load()
      • NN_UQ.modify_dropout()
      • NN_UQ.predict()
      • NN_UQ.reset()
      • NN_UQ.save()
      • NN_UQ.set_fit_request()
      • NN_UQ.set_predict_request()
    • default_Generator
      • default_Generator.load()
      • default_Generator.on_epoch_end()
    • generate_K_fold_removing_index()
    • generate_train_test()
    • get_params_dict()
    • get_training_parameters()
  • uqmodels.modelization.DL_estimator.transformer_ed module
    • Dense
    • Dropout
    • LayerNormalization
    • MultiHeadAttention
    • TransformerDecoder
      • TransformerDecoder.call()
      • TransformerDecoder.causal_attention_mask()
      • TransformerDecoder.from_config()
      • TransformerDecoder.get_config()
    • TransformerEncoder
      • TransformerEncoder.call()
      • TransformerEncoder.from_config()
      • TransformerEncoder.get_config()
    • Transformer_ED_UQ
      • Transformer_ED_UQ.Build_generator()
      • Transformer_ED_UQ.factory()
      • Transformer_ED_UQ.set_fit_request()
      • Transformer_ED_UQ.set_predict_request()
    • build_transformer()
    • get_params_dict()
  • uqmodels.modelization.DL_estimator.utils module
    • Folder_Generator
      • Folder_Generator.load()
      • Folder_Generator.on_epoch_end()
    • Generator
      • Generator.load()
      • Generator.on_epoch_end()
    • find_conv_kernel()
    • identity()
    • set_global_determinism()
    • set_seeds()
    • size_post_conv()
    • sum_part_prod()
  • Module contents
• uqmodels.modelization.ML_estimator package
  • Submodules
  • uqmodels.modelization.ML_estimator.baseline module
    • GBRQ_UQEstimator
      • GBRQ_UQEstimator.fit()
      • GBRQ_UQEstimator.predict()
      • GBRQ_UQEstimator.set_fit_request()
      • GBRQ_UQEstimator.set_predict_request()
    • GPR_UQEstimator
      • GPR_UQEstimator.fit()
      • GPR_UQEstimator.predict()
      • GPR_UQEstimator.set_fit_request()
      • GPR_UQEstimator.set_predict_request()
    • REGML_UQEstimator
      • REGML_UQEstimator.fit()
      • REGML_UQEstimator.get_params()
      • REGML_UQEstimator.predict()
      • REGML_UQEstimator.set_fit_request()
      • REGML_UQEstimator.set_predict_request()
  • uqmodels.modelization.ML_estimator.random_forest_UQ module
    • RF_UQEstimator
      • RF_UQEstimator.RF_extraction()
      • RF_UQEstimator.fit()
      • RF_UQEstimator.predict()
      • RF_UQEstimator.set_fit_request()
      • RF_UQEstimator.set_predict_request()
    • get_params_dict()
  • Module contents

Submodules

uqmodels.modelization.UQEstimator module

class uqmodels.modelization.UQEstimator.MeanVarUQEstimator(estimator=None, estimator_var=None, type_UQ='var', name='MeanVarUQEstimator', rescale=False, var_min=1e-05, random_state=None)

Bases: UQEstimator

Mean var UQ Estimator that estimate a mean values and estimate irreductible

fit(X, y, skip_format=False, **kwargs)

Fit UQestimator using training data. :param X: train features :param y: train targets/observations

predict(X, skip_format=False, **kwargs)

Compute prediction (or provide None) and UQ-measure :param X: features

Returns:

pred, UQ_measure

set_fit_request(*, skip_format: bool | None | str = '$UNCHANGED$') → MeanVarUQEstimator

Request metadata passed to the fit 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 fit 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 fit.

• 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.Pipeline. Otherwise it has no effect.

Parameters:

skip_format (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – Metadata routing for skip_format parameter in fit.

Returns:

self – The updated object.

Return type:

object

set_predict_request(*, skip_format: bool | None | str = '$UNCHANGED$') → MeanVarUQEstimator

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.Pipeline. Otherwise it has no effect.

Parameters:

skip_format (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – Metadata routing for skip_format parameter in predict.

Returns:

self – The updated object.

Return type:

object

class uqmodels.modelization.UQEstimator.QuantileUQEstimator(list_estimators, list_alpha: list = [0.025, 0.5, 0.975], type_UQ: str = 'quantile', name: str = 'QuantileUQEstimator', rescale=False, var_min=1e-05, random_state=None, **kwargs)

Bases: UQEstimator

fit(X, y, skip_format=False, **kwargs)

Fit UQestimator using training data. :param X: train features :param y: train targets/observations

predict(X, skip_format=False, **kwargs)

Compute prediction (or provide None) and UQ-measure :param X: features

Returns:

pred, UQ_measure

set_fit_request(*, skip_format: bool | None | str = '$UNCHANGED$') → QuantileUQEstimator

Request metadata passed to the fit 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 fit 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 fit.

• 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.Pipeline. Otherwise it has no effect.

Parameters:

skip_format (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – Metadata routing for skip_format parameter in fit.

Returns:

self – The updated object.

Return type:

object

set_predict_request(*, skip_format: bool | None | str = '$UNCHANGED$') → QuantileUQEstimator

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.Pipeline. Otherwise it has no effect.

Parameters:

skip_format (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – Metadata routing for skip_format parameter in predict.

Returns:

self – The updated object.

Return type:

object

class uqmodels.modelization.UQEstimator.UQEstimator(name='UQEstimator', type_UQ='None', rescale=False, type_UQ_params=None, var_min=1e-06, random_state=None)

Bases: BaseEstimator

Abstract structure of a UQEstimator : Estimator (fit/predict) that perform prediction(optionaly) and UQmeasure estimation

factory(X, y, type_transform='transform', only_fit_scaler=False, **kwargs)

abstract fit(X: array, y: array, skip_format=False, **kwargs) → None

Fit UQestimator using training data. :param X: train features :param y: train targets/observations

get_params(deep=False)

Get parameters for this estimator.

Parameters:

deep (bool, default=True) – If True, will return the parameters for this estimator and contained subobjects that are estimators.

Returns:

params – Parameter names mapped to their values.

Return type:

dict

abstract predict(X: array, skip_format=False, **kwargs)

Compute prediction (or provide None) and UQ-measure :param X: features

Returns:

pred, UQ_measure

set_fit_request(*, skip_format: bool | None | str = '$UNCHANGED$') → UQEstimator

Request metadata passed to the fit 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 fit 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 fit.

• 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.Pipeline. Otherwise it has no effect.

Parameters:

skip_format (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – Metadata routing for skip_format parameter in fit.

Returns:

self – The updated object.

Return type:

object

set_predict_request(*, skip_format: bool | None | str = '$UNCHANGED$') → UQEstimator

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.Pipeline. Otherwise it has no effect.

Parameters:

skip_format (str, True, False, or None, default=sklearn.utils.metadata_routing.UNCHANGED) – Metadata routing for skip_format parameter in predict.

Returns:

self – The updated object.

Return type:

object

uqmodels.modelization.UQEstimator.check_type_UQ(type_UQ)

uqmodels.modelization.UQEstimator.get_UQEstimator_parameters(model_parameters={}, factory_parameters={}, training_parameters=None, type_output=None, rescale=False, random_state=None, **kwargs)

Generate dict object containing UQEstimators parameters to provide to init().

Parameters:

• model_parameters (dict, optional) – UQestimators parameters. Defaults to {}.

• factory_parameters (dict, optional) – Factory parameters, to data preprocessing. Defaults to {}.

• training_parameters (_type_, optional) – Model training parameters for DEEP estimators. Defaults to None.

• type_output (_type_, optional) – Specification of deep learning output. Defaults to None.

• rescale (bool, optional) – Use or not internal rescale function Defaults to False.

• random_state (bool) – handle experimental random using seed.

Returns:

UQEstimators parameters

Return type:

dict

Module contents