gemseo / mlearning / classification

Show inherited members

svm module

The Support Vector Machine algorithm for classification.

This module implements the SVMClassifier class. A support vector machine (SVM) passes the data through a kernel in order to increase its dimension and thereby make the classes linearly separable.

Dependence

The classifier relies on the SVC class of the scikit-learn library.

class gemseo.mlearning.classification.svm.SVMClassifier(data, transformer=mappingproxy({}), input_names=None, output_names=None, C=1.0, kernel='rbf', probability=False, **parameters)[source]

Bases: MLClassificationAlgo

The Support Vector Machine algorithm for classification.

Parameters:

  • data (IODataset) – 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 IDENTITY, do not transform the variables.

    By default it is set to {}.

  • input_names (Iterable[str] | None) – The names of the input variables. If None, consider all the input variables of the learning dataset.

  • output_names (Iterable[str] | None) – The names of the output variables. If None, consider all the output variables of the learning dataset.

  • C (float) –

    The inverse L2 regularization parameter. Higher values give less regularization.

    By default it is set to 1.0.

  • kernel (str | Callable | None) –

    The name of the kernel or a callable for the SVM. Examples: “linear”, “poly”, “rbf”, “sigmoid”, “precomputed” or a callable.

    By default it is set to “rbf”.

  • probability (bool) –

    Whether to enable the probability estimates. The algorithm is faster if set to False.

    By default it is set to False.

  • **parameters (int | float | bool | str | None) – The parameters of the machine learning algorithm.

Raises:

ValueError – When both the variable and the group it belongs to have a transformer.

LIBRARY: Final[str] = 'scikit-learn'

The name of the library of the wrapped machine learning algorithm.

SHORT_ALGO_NAME: ClassVar[str] = 'SVM'

The short name of the machine learning algorithm, often an acronym.

Typically used for composite names, e.g. f"{algo.SHORT_ALGO_NAME}_{dataset.name}" or f"{algo.SHORT_ALGO_NAME}_{discipline.name}".

algo: Any

The interfaced machine learning algorithm.

input_names: list[str]

The names of the input variables.

input_space_center: dict[str, ndarray]

The center of the input space.

learning_set: IODataset

The learning dataset.

n_classes: int

The number of classes.

output_names: list[str]

The names of the output variables.

parameters: dict[str, MLAlgoParameterType]

The parameters of the machine learning algorithm.

transformer: dict[str, Transformer]

The strategies to transform the variables, if any.

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.