Note
Go to the end to download the full example code
Classification API¶
Here are some examples of the machine learning API applied to classification models.
from __future__ import annotations
from gemseo import configure_logger
from gemseo import create_benchmark_dataset
from gemseo.mlearning import create_classification_model
from gemseo.mlearning import get_classification_models
from gemseo.mlearning import get_classification_options
configure_logger()
<RootLogger root (INFO)>
Get available classification models¶
get_classification_models()
['KNNClassifier', 'RandomForestClassifier', 'SVMClassifier']
Get classification model options¶
get_classification_options("KNNClassifier")
+---------------------------+--------------------------------------------------------------------------------------------+---------------------------+
| Name | Description | Type |
+---------------------------+--------------------------------------------------------------------------------------------+---------------------------+
| input_names | The names of the input variables. if ``none``, consider all the input variables of the | null |
| | learning dataset. | |
| n_neighbors | The number of neighbors. | integer |
| output_names | The names of the output variables. if ``none``, consider all the output variables of the | null |
| | learning dataset. | |
| transformer | The strategies to transform the variables. the values are instances of | object |
| | :class:`.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 :class:`.transformer` will be applied to all the variables of | |
| | this group. if :attr:`.identity`, do not transform the variables. | |
+---------------------------+--------------------------------------------------------------------------------------------+---------------------------+
INFO - 13:10:28: +---------------------------+--------------------------------------------------------------------------------------------+---------------------------+
INFO - 13:10:28: | Name | Description | Type |
INFO - 13:10:28: +---------------------------+--------------------------------------------------------------------------------------------+---------------------------+
INFO - 13:10:28: | input_names | The names of the input variables. if ``none``, consider all the input variables of the | null |
INFO - 13:10:28: | | learning dataset. | |
INFO - 13:10:28: | n_neighbors | The number of neighbors. | integer |
INFO - 13:10:28: | output_names | The names of the output variables. if ``none``, consider all the output variables of the | null |
INFO - 13:10:28: | | learning dataset. | |
INFO - 13:10:28: | transformer | The strategies to transform the variables. the values are instances of | object |
INFO - 13:10:28: | | :class:`.transformer` while the keys are the names of either the variables or the groups | |
INFO - 13:10:28: | | of variables, e.g. ``"inputs"`` or ``"outputs"`` in the case of the regression algorithms. | |
INFO - 13:10:28: | | if a group is specified, the :class:`.transformer` will be applied to all the variables of | |
INFO - 13:10:28: | | this group. if :attr:`.identity`, do not transform the variables. | |
INFO - 13:10:28: +---------------------------+--------------------------------------------------------------------------------------------+---------------------------+
{'$schema': 'http://json-schema.org/schema#', 'type': 'object', 'properties': {'transformer': {'description': 'The strategies to transform the variables. The values are instances of :class:`.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 :class:`.Transformer` will be applied to all the variables of this group. If :attr:`.IDENTITY`, do not transform the variables.', 'type': 'object'}, 'input_names': {'description': 'The names of the input variables. If ``None``, consider all the input variables of the learning dataset.', 'type': 'null'}, 'output_names': {'description': 'The names of the output variables. If ``None``, consider all the output variables of the learning dataset.', 'type': 'null'}, 'n_neighbors': {'description': 'The number of neighbors.', 'type': 'integer'}}}
Create classification model¶
iris = create_benchmark_dataset("IrisDataset", as_io=True)
model = create_classification_model("KNNClassifier", data=iris)
model.learn()
model
Total running time of the script: (0 minutes 0.045 seconds)