gemseo.mlearning.data_formatters.supervised_data_formatters module#

Data formatters for supervised machine learning algorithms.

class SupervisedDataFormatters[source]#

Bases: BaseDataFormatters

Data formatters for supervised machine learning algorithms.

classmethod format_dict(func)[source]#

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

Parameters:

func (Callable[[BaseMLSupervisedAlgo, ndarray, Any, ...], ndarray]) -- The function to be called; it takes a NumPy array in input and returns a NumPy array.

Returns:

A function making the function func 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[[BaseMLSupervisedAlgo, DataType, Any, ...], DataType]

classmethod format_input_output(input_axis=0)[source]#

Create a decorator for functions computing output data from input data.

This decorator will make a 2D NumPy array-based function work with 1D NumPy array, dictionaries of arrays and data transformation.

Parameters:

input_axis (int) --

The axis representing the input values.

By default it is set to 0.

Returns:

The decorator for functions computing output data from input data.

Return type:

Callable[[Callable[[BaseMLSupervisedAlgo, ndarray, Any, ...], ndarray]], Callable[[BaseMLSupervisedAlgo, DataType, Any, ...], DataType]]

classmethod format_samples(input_axis=0)[source]#

Create a decorator for functions computing output data from input data.

This decorator will make a 2D NumPy array-based function work with 1D NumPy arrays.

Parameters:

input_axis (int) --

The axis representing the input values.

By default it is set to 0.

Returns:

The decorator for functions computing output data from input data.

Return type:

Callable[[Callable[[BaseMLSupervisedAlgo, ndarray, Any, ...], ndarray]], Callable[[BaseMLSupervisedAlgo, ndarray, Any, ...], DataType]]

classmethod format_transform(transform_inputs=True, transform_outputs=True)[source]#

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[[Callable[[BaseMLSupervisedAlgo, ndarray, Any, ...], ndarray]], Callable[[BaseMLSupervisedAlgo, ndarray, Any, ...], ndarray]]