gemseo / mlearning / quality_measures

Hide inherited members

quality_measure module

Measuring the quality of a machine learning algorithm.

class gemseo.mlearning.quality_measures.quality_measure.BaseMLQualityMeasure(algo, fit_transformers=True)[source]

Bases: object

An abstract quality measure to assess a machine learning algorithm.

This measure can be minimized (e.g. MSEMeasure) or maximized (e.g. R2Measure).

It can be evaluated from the learning dataset, from a test dataset or using resampling techniques such as boostrap, cross-validation or leave-one-out.

The machine learning algorithm is usually trained. If not but required by the evaluation technique, the quality measure will train it.

Lastly, the transformers of the algorithm fitted from the learning dataset can be used as is by the resampling methods or re-fitted for each algorithm trained on a subset of the learning dataset.

Parameters:

  • algo (BaseMLAlgo) – A machine learning algorithm.

  • fit_transformers (bool) –

    Whether to re-fit the transformers when using resampling techniques. If False, use the transformers of the algorithm fitted from the whole learning dataset.

    By default it is set to True.

class EvaluationFunctionName(value)[source]

Bases: StrEnum

The name of the function associated with an evaluation method.

BOOTSTRAP = 'evaluate_bootstrap'
KFOLDS = 'evaluate_kfolds'
LEARN = 'evaluate_learn'
LOO = 'evaluate_loo'
TEST = 'evaluate_test'
class EvaluationMethod(value)[source]

Bases: StrEnum

The evaluation method.

BOOTSTRAP = 'BOOTSTRAP'

The name of the method to evaluate the measure by bootstrap.

KFOLDS = 'KFOLDS'

The name of the method to evaluate the measure by cross-validation.

LEARN = 'LEARN'

The name of the method to evaluate the measure on the learning dataset.

LOO = 'LOO'

The name of the method to evaluate the measure by leave-one-out.

TEST = 'TEST'

The name of the method to evaluate the measure on a test dataset.

abstract compute_bootstrap_measure(n_replicates=100, samples=None, multioutput=True, seed=None, store_resampling_result=False)[source]

Evaluate the quality measure using the bootstrap technique.

Parameters:

  • n_replicates (int) –

    The number of bootstrap replicates.

    By default it is set to 100.

  • samples (Sequence[int] | None) – The indices of the learning samples. If None, use the whole learning dataset.

  • multioutput (bool) –

    Whether the quality measure is returned for each component of the outputs. Otherwise, the average quality measure.

    By default it is set to True.

  • seed (int | None) – The seed of the pseudo-random number generator. If None, an unpredictable generator will be used.

  • store_resampling_result (bool) –

    Whether to store the \(n\) machine learning algorithms and associated predictions generated by the resampling stage where \(n\) is the number of bootstrap replicates.

    By default it is set to False.

Returns:

The value of the quality measure.

Return type:

MeasureType

abstract compute_cross_validation_measure(n_folds=5, samples=None, multioutput=True, randomize=True, seed=None, store_resampling_result=False)[source]

Evaluate the quality measure using the k-folds technique.

Parameters:

  • n_folds (int) –

    The number of folds.

    By default it is set to 5.

  • samples (Sequence[int] | None) – The indices of the learning samples. If None, use the whole learning dataset.

  • multioutput (bool) –

    Whether the quality measure is returned for each component of the outputs. Otherwise, the average quality measure.

    By default it is set to True.

  • randomize (bool) –

    Whether to shuffle the samples before dividing them in folds.

    By default it is set to True.

  • seed (int | None) – The seed of the pseudo-random number generator. If None, an unpredictable generator is used.

  • store_resampling_result (bool) –

    Whether to store the \(n\) machine learning algorithms and associated predictions generated by the resampling stage where \(n\) is the number of folds.

    By default it is set to False.

Returns:

The value of the quality measure.

Return type:

MeasureType

abstract compute_learning_measure(samples=None, multioutput=True)[source]

Evaluate the quality measure from the learning dataset.

Parameters:

  • samples (Sequence[int] | None) – The indices of the learning samples. If None, use the whole learning dataset.

  • multioutput (bool) –

    Whether the quality measure is returned for each component of the outputs. Otherwise, the average quality measure.

    By default it is set to True.

Returns:

The value of the quality measure.

Return type:

MeasureType

compute_leave_one_out_measure(samples=None, multioutput=True, store_resampling_result=True)[source]

Evaluate the quality measure using the leave-one-out technique.

Parameters:

  • samples (Sequence[int] | None) – The indices of the learning samples. If None, use the whole learning dataset.

  • multioutput (bool) –

    Whether the quality measure is returned for each component of the outputs. Otherwise, the average quality measure.

    By default it is set to True.

  • store_resampling_result (bool) –

    Whether to store the \(n\) machine learning algorithms and associated predictions generated by the resampling stage where \(n\) is the number of learning samples.

    By default it is set to True.

Returns:

The value of the quality measure.

Return type:

MeasureType

abstract compute_test_measure(test_data, samples=None, multioutput=True)[source]

Evaluate the quality measure using a test dataset.

Parameters:

  • test_data (Dataset) – The test dataset.

  • samples (Sequence[int] | None) – The indices of the learning samples. If None, use the whole learning dataset.

  • multioutput (bool) –

    Whether the quality measure is returned for each component of the outputs. Otherwise, the average quality measure.

    By default it is set to True.

Returns:

The value of the quality measure.

Return type:

MeasureType

evaluate_loo(samples=None, multioutput=True, store_resampling_result=True)

Evaluate the quality measure using the leave-one-out technique.

Parameters:

  • samples (Sequence[int] | None) – The indices of the learning samples. If None, use the whole learning dataset.

  • multioutput (bool) –

    Whether the quality measure is returned for each component of the outputs. Otherwise, the average quality measure.

    By default it is set to True.

  • store_resampling_result (bool) –

    Whether to store the \(n\) machine learning algorithms and associated predictions generated by the resampling stage where \(n\) is the number of learning samples.

    By default it is set to True.

Returns:

The value of the quality measure.

Return type:

MeasureType

classmethod is_better(val1, val2)[source]

Compare the quality between two values.

This method returns True if the first one is better than the second one.

For most measures, a smaller value is “better” than a larger one (MSE etc.). But for some, like an R2-measure, higher values are better than smaller ones. This comparison method correctly handles this, regardless of the type of measure.

Parameters:

  • val1 (float) – The value of the first quality measure.

  • val2 (float) – The value of the second quality measure.

Returns:

Whether val1 is of better quality than val2.

Return type:

bool

SMALLER_IS_BETTER: ClassVar[bool] = True

Whether to minimize or maximize the measure.

algo: BaseMLAlgo

The machine learning algorithm whose quality we want to measure.

class gemseo.mlearning.quality_measures.quality_measure.MLQualityMeasureFactory[source]

Bases: BaseFactory

A factory of BaseMLQualityMeasure.

Return type:

Any

create(class_name, *args, **kwargs)

Return an instance of a class.

Parameters:

  • class_name (str) – The name of the class.

  • **args (Any) – The positional arguments to be passed to the class constructor.

  • **kwargs (Any) – The keyword arguments to be passed to the class constructor.

Returns:

The instance of the class.

Raises:

TypeError – If the class cannot be instantiated.

Return type:

T

get_class(name)

Return a class from its name.

Parameters:

name (str) – The name of the class.

Returns:

The class.

Raises:

ImportError – If the class is not available.

Return type:

type[T]

get_default_option_values(name)

Return the constructor kwargs default values of a class.

Parameters:

name (str) – The name of the class.

Returns:

The mapping from the argument names to their default values.

Return type:

dict[str, str | int | float | bool]

get_default_sub_option_values(name, **options)

Return the default values of the sub options of a class.

Parameters:

  • name (str) – The name of the class.

  • **options (str) – The options to be passed to the class required to deduce the sub options.

Returns:

The JSON grammar.

Return type:

JSONGrammar

get_library_name(name)

Return the name of the library related to the name of a class.

Parameters:

name (str) – The name of the class.

Returns:

The name of the library.

Return type:

str

get_options_doc(name)

Return the constructor documentation of a class.

Parameters:

name (str) – The name of the class.

Returns:

The mapping from the argument names to their documentation.

Return type:

dict[str, str]

get_options_grammar(name, write_schema=False, schema_path='')

Return the options JSON grammar for a class.

Attempt to generate a JSONGrammar from the arguments of the __init__ method of the class.

Parameters:

  • name (str) – The name of the class.

  • write_schema (bool) –

    If True, write the JSON schema to a file.

    By default it is set to False.

  • schema_path (Path | str) –

    The path to the JSON schema file. If None, the file is saved in the current directory in a file named after the name of the class.

    By default it is set to “”.

Returns:

The JSON grammar.

Return type:

JSONGrammar

get_sub_options_grammar(name, **options)

Return the JSONGrammar of the sub options of a class.

Parameters:

  • name (str) – The name of the class.

  • **options (str) – The options to be passed to the class required to deduce the sub options.

Returns:

The JSON grammar.

Return type:

JSONGrammar

is_available(name)

Return whether a class can be instantiated.

Parameters:

name (str) – The name of the class.

Returns:

Whether the class can be instantiated.

Return type:

bool

update()

Search for the classes that can be instantiated.

The search is done in the following order:

  1. The fully qualified module names

  2. The plugin packages

  3. The packages from the environment variables

Return type:

None

PLUGIN_ENTRY_POINT: ClassVar[str] = 'gemseo_plugins'

The name of the setuptools entry point for declaring plugins.

property class_names: list[str]

The sorted names of the available classes.

failed_imports: dict[str, str]

The class names bound to the import errors.

Examples using BaseMLQualityMeasure

Calibration of a polynomial regression

Calibration of a polynomial regression

Machine learning algorithm selection example

Machine learning algorithm selection example

Cross-validation

Cross-validation

Leave-one-out

Leave-one-out

MSE for regression models

MSE for regression models

R2 for regression models

R2 for regression models

RMSE for regression models

RMSE for regression models

Advanced mixture of experts

Advanced mixture of experts

Scaling

Scaling