gemseo / mlearning / regression

factory module

A factory to create regression models.

This module contains a factory to instantiate a MLRegressionAlgo from its class name. It also provides the available regression models and allows to test if a regression model type is available.

Classes:

RegressionModelFactory()

This factory instantiates a MLRegressionAlgo from its class name.

class gemseo.mlearning.regression.factory.RegressionModelFactory

Bases: gemseo.mlearning.core.factory.MLAlgoFactory

This factory instantiates a MLRegressionAlgo from its class name.

The class can be either internal to GEMSEO or external. In this second case, it can be either implemented in a module referenced in the “GEMSEO_PATH” or in a module The class can be either internal to GEMSEO or external. In the second case, it can be either implemented in a module referenced in the GEMSEO_PATH environment variable or in a module starting with “gemseo_” and referenced in the PYTHONPATH environment variable.

Methods:

create(ml_algo, **options)	Create an instance of a machine learning algorithm.
is_available(ml_algo)	Check the availability of a machine learning algorithm.
load(directory)	Load an instance of machine learning algorithm from the disk.

Attributes:

models

The available machine learning algorithms.

Return type

None

create(ml_algo, **options)

Create an instance of a machine learning algorithm.

Parameters

• ml_algo (str) – The name of a machine learning algorithm (its class name).

• **options – The options of the machine learning algorithm.

• options (Optional[Union[gemseo.core.dataset.Dataset, Dict[str, gemseo.mlearning.transform.transformer.Transformer], Any]]) –

Returns

The instance of the machine learning algorithm.

Return type

gemseo.mlearning.core.ml_algo.MLAlgo

is_available(ml_algo)

Check the availability of a machine learning algorithm.

Parameters

ml_algo (str) – The name of a machine learning algorithm (its class name).

Returns

The availability of the machine learning algorithm.

Return type

bool

load(directory)

Load an instance of machine learning algorithm from the disk.

Parameters

directory (str) – The name of the directory containing an instance of a machine learning algorithm.

Returns

The instance of the machine learning algorithm.

Return type

gemseo.mlearning.core.ml_algo.MLAlgo

property models

The available machine learning algorithms.