gemseo / mlearning / classification

classification module

This module contains the base class for classification algorithms.

The classification module implements classification algorithms, whose goal is to assess the membership of input data to classes.

Classification algorithms provide methods for predicting classes of new input data, as well as predicting the probabilities of belonging to each of the classes wherever possible.

This concept is implemented through the MLClassificationAlgo class which inherits from the MLSupervisedAlgo class.

Classes:

MLClassificationAlgo(data[, transformer, ...])

Classification Algorithm.

class gemseo.mlearning.classification.classification.MLClassificationAlgo(data, transformer={'inputs': <gemseo.mlearning.transform.scaler.min_max_scaler.MinMaxScaler object>}, input_names=None, output_names=None, **parameters)[source]

Bases: gemseo.mlearning.core.supervised.MLSupervisedAlgo

Classification Algorithm.

Inheriting classes shall implement the MLSupervisedAlgo._fit() and MLClassificationAlgo._predict() methods, and MLClassificationAlgo._predict_proba_soft() method if possible.

learning_set

The learning dataset.

Type

Dataset

parameters

The parameters of the machine learning algorithm.

Type

Dict[str,MLAlgoParameterType]

transformer

The strategies to transform the variables. The values are instances of Transformer while the keys are the names of either the variables or the groups of variables, e.g. “inputs” or “outputs” in the case of the regression algorithms. If a group is specified, the Transformer will be applied to all the variables of this group. If None, do not transform the variables.

Type

Dict[str,Transformer]

algo

The interfaced machine learning algorithm.

Type

Any

input_names

The names of the input variables.

Type

List[str]

output_names

The names of the output variables.

Type

List[str]

input_space_center

The center of the input space.

Type

Dict[str,ndarray]

n_classes

The number of classes.

Type

int

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

Parameters
  • data (Dataset) – The learning dataset.

  • transformer (TransformerType) –

    The strategies to transform the variables. The values are instances of Transformer while the keys are the names of either the variables or the groups of variables, e.g. “inputs” or “outputs” in the case of the regression algorithms. If a group is specified, the Transformer will be applied to all the variables of this group. If None, do not transform the variables.

    By default it is set to {‘inputs’: <gemseo.mlearning.transform.scaler.min_max_scaler.MinMaxScaler object at 0x7f3b98413310>}.

  • input_names (Optional[Iterable[str]]) –

    The names of the input variables. If None, consider all input variables mentioned in the learning dataset.

    By default it is set to None.

  • output_names (Optional[Iterable[str]]) –

    The names of the output variables. If None, consider all input variables mentioned in the learning dataset.

    By default it is set to None.

  • **parameters (MLAlgoParameterType) – The parameters of the machine learning algorithm.

Return type

None

Attributes:

ABBR

DEFAULT_TRANSFORMER

FILENAME

LIBRARY

input_data

The input data matrix.

input_shape

The dimension of the input variables before applying the transformers.

is_trained

Return whether the algorithm is trained.

learning_samples_indices

The indices of the learning samples used for the training.

output_data

The output data matrix.

output_shape

The dimension of the output variables before applying the transformers.

Classes:

DataFormatters()

Decorators for supervised algorithms.

Methods:

learn([samples])

Train the machine learning algorithm from the learning dataset.

load_algo(directory)

Load a machine learning algorithm from a directory.

predict(input_data, *args, **kwargs)

Evaluate 'predict' with either array or dictionary-based input data.

predict_proba(input_data, *args, **kwargs)

Evaluate 'predict' with either array or dictionary-based input data.

save([directory, path, save_learning_set])

Save the machine learning algorithm.

ABBR = 'MLSupervisedAlgo'
DEFAULT_TRANSFORMER = {'inputs': <gemseo.mlearning.transform.scaler.min_max_scaler.MinMaxScaler object>}
class DataFormatters

Bases: gemseo.mlearning.core.ml_algo.MLAlgo.DataFormatters

Decorators for supervised algorithms.

Methods:

format_dict(predict)

Make an array-based function be called with a dictionary of NumPy arrays.

format_input_output(predict)

Make a function robust to type, array shape and data transformation.

format_samples(predict)

Make a 2D NumPy array-based function work with 1D NumPy array.

format_transform([transform_inputs, ...])

Force a function to transform its input and/or output variables.

classmethod format_dict(predict)

Make an array-based function be called with a dictionary of NumPy arrays.

Parameters

predict (Callable[[numpy.ndarray], numpy.ndarray]) – The function to be called; it takes a NumPy array in input and returns a NumPy array.

Returns

A function making the function ‘predict’ work with either a NumPy data array or a dictionary of NumPy data arrays indexed by variables names. The evaluation will have the same type as the input data.

Return type

Callable[[Union[numpy.ndarray, Mapping[str, numpy.ndarray]]], Union[numpy.ndarray, Mapping[str, numpy.ndarray]]]

classmethod format_input_output(predict)

Make a function robust to type, array shape and data transformation.

Parameters

predict (Callable[[numpy.ndarray], numpy.ndarray]) – The function of interest to be called.

Returns

A function calling the function of interest ‘predict’, while guaranteeing consistency in terms of data type and array shape, and applying input and/or output data transformation if required.

Return type

Callable[[Union[numpy.ndarray, Mapping[str, numpy.ndarray]]], Union[numpy.ndarray, Mapping[str, numpy.ndarray]]]

classmethod format_samples(predict)

Make a 2D NumPy array-based function work with 1D NumPy array.

Parameters

predict (Callable[[numpy.ndarray], numpy.ndarray]) – The function to be called; it takes a 2D NumPy array in input and returns a 2D NumPy array. The first dimension represents the samples while the second one represents the components of the variables.

Returns

A function making the function ‘predict’ work with either a 1D NumPy array or a 2D NumPy array. The evaluation will have the same dimension as the input data.

Return type

Callable[[numpy.ndarray], numpy.ndarray]

classmethod format_transform(transform_inputs=True, transform_outputs=True)

Force a function to transform its input and/or output variables.

Parameters
  • transform_inputs (bool) –

    Whether to transform the input variables.

    By default it is set to True.

  • transform_outputs (bool) –

    Whether to transform the output variables.

    By default it is set to True.

Returns

A function evaluating a function of interest, after transforming its input data and/or before transforming its output data.

Return type

Callable[[numpy.ndarray], numpy.ndarray]

FILENAME = 'ml_algo.pkl'
LIBRARY = None
property input_data

The input data matrix.

property input_shape

The dimension of the input variables before applying the transformers.

property is_trained

Return whether the algorithm is trained.

learn(samples=None)

Train the machine learning algorithm from the learning dataset.

Parameters

samples (Optional[Sequence[int]]) –

The indices of the learning samples. If None, use the whole learning dataset.

By default it is set to None.

Return type

None

property learning_samples_indices

The indices of the learning samples used for the training.

load_algo(directory)

Load a machine learning algorithm from a directory.

Parameters

directory (Union[str, pathlib.Path]) – The path to the directory where the machine learning algorithm is saved.

Return type

None

property output_data

The output data matrix.

property output_shape

The dimension of the output variables before applying the transformers.

predict(input_data, *args, **kwargs)

Evaluate ‘predict’ with either array or dictionary-based input data.

Firstly, the pre-processing stage converts the input data to a NumPy data array, if these data are expressed as a dictionary of NumPy data arrays.

Then, the processing evaluates the function ‘predict’ from this NumPy input data array.

Lastly, the post-processing transforms the output data to a dictionary of output NumPy data array if the input data were passed as a dictionary of NumPy data arrays.

Parameters
  • input_data (Union[numpy.ndarray, Mapping[str, numpy.ndarray]]) – The input data.

  • *args – The positional arguments of the function ‘predict’.

  • **kwargs – The keyword arguments of the function ‘predict’.

Returns

The output data with the same type as the input one.

Return type

Union[numpy.ndarray, Mapping[str, numpy.ndarray]]

predict_proba(input_data, *args, **kwargs)

Evaluate ‘predict’ with either array or dictionary-based input data.

Firstly, the pre-processing stage converts the input data to a NumPy data array, if these data are expressed as a dictionary of NumPy data arrays.

Then, the processing evaluates the function ‘predict’ from this NumPy input data array.

Lastly, the post-processing transforms the output data to a dictionary of output NumPy data array if the input data were passed as a dictionary of NumPy data arrays.

Parameters
  • input_data (Union[numpy.ndarray, Mapping[str, numpy.ndarray]]) – The input data.

  • *args – The positional arguments of the function ‘predict’.

  • **kwargs – The keyword arguments of the function ‘predict’.

Returns

The output data with the same type as the input one.

Return type

Union[numpy.ndarray, Mapping[str, numpy.ndarray]]

save(directory=None, path='.', save_learning_set=False)

Save the machine learning algorithm.

Parameters
  • directory (Optional[str]) –

    The name of the directory to save the algorithm.

    By default it is set to None.

  • path (Union[str, pathlib.Path]) –

    The path to parent directory where to create the directory.

    By default it is set to ..

  • save_learning_set (bool) –

    Whether to save the learning set or get rid of it to lighten the saved files.

    By default it is set to False.

Returns

The path to the directory where the algorithm is saved.

Return type

str