AdaBoostClassifier
Bases: Classifier
, _AdaBoostBase
Ada Boost classification.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
learner |
Classifier | None | Choice[Classifier | None]
|
The learner from which the boosted ensemble is built. |
None
|
max_learner_count |
int | Choice[int]
|
The maximum number of learners at which boosting is terminated. In case of perfect fit, the learning procedure is stopped early. Has to be greater than 0. |
50
|
learning_rate |
float | Choice[float]
|
Weight applied to each classifier at each boosting iteration. A higher learning rate increases the contribution of each classifier. Has to be greater than 0. |
1.0
|
Raises:
Type | Description |
---|---|
OutOfBoundsError
|
If |
Source code in src/safeds/ml/classical/classification/_ada_boost_classifier.py
16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 |
|
is_fitted: bool
¶
Whether the model is fitted.
learner: Classifier | None | Choice[Classifier | None]
¶
The base learner used for training the ensemble.
learning_rate: float | Choice[float]
¶
The learning rate.
max_learner_count: int | Choice[int]
¶
The maximum number of learners in the ensemble.
accuracy
¶
Compute the accuracy of the classifier on the given data.
The accuracy is the proportion of predicted target values that were correct. The higher the accuracy, the better. Results range from 0.0 to 1.0.
Note: The model must be fitted.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
validation_or_test_set |
Table | TabularDataset
|
The validation or test set. |
required |
Returns:
Name | Type | Description |
---|---|---|
accuracy |
float
|
The classifier's accuracy. |
Raises:
Type | Description |
---|---|
ModelNotFittedError
|
If the classifier has not been fitted yet. |
Source code in src/safeds/ml/classical/classification/_classifier.py
f1_score
¶
Compute the classifier's F₁ score on the given data.
The F₁ score is the harmonic mean of precision and recall. The higher the F₁ score, the better the classifier. Results range from 0.0 to 1.0.
Note: The model must be fitted.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
validation_or_test_set |
Table | TabularDataset
|
The validation or test set. |
required |
positive_class |
Any
|
The class to be considered positive. All other classes are considered negative. |
required |
Returns:
Name | Type | Description |
---|---|---|
f1_score |
float
|
The classifier's F₁ score. |
Raises:
Type | Description |
---|---|
ModelNotFittedError
|
If the classifier has not been fitted yet. |
Source code in src/safeds/ml/classical/classification/_classifier.py
fit
¶
Create a copy of this model and fit it with the given training data.
Note: This model is not modified.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
training_set |
TabularDataset
|
The training data containing the features and target. |
required |
Returns:
Name | Type | Description |
---|---|---|
fitted_model |
Self
|
The fitted model. |
Raises:
Type | Description |
---|---|
PlainTableError
|
If a table is passed instead of a TabularDataset. |
DatasetMissesDataError
|
If the given training set contains no data. |
FittingWithChoiceError
|
When trying to call this method on a model with hyperparameter choices. |
LearningError
|
If the training data contains invalid values or if the training failed. |
Source code in src/safeds/ml/classical/_supervised_model.py
fit_by_exhaustive_search
¶
Use the hyperparameter choices to create multiple models and fit them.
Note: This model is not modified.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
training_set |
TabularDataset
|
The training data containing the features and target. |
required |
optimization_metric |
ClassifierMetric
|
The metric that should be used for determining the performance of a model. |
required |
positive_class |
Any
|
The class to be considered positive. All other classes are considered negative. Needs to be provided when choosing precision, f1score or recall as optimization metric. |
None
|
Returns:
Name | Type | Description |
---|---|---|
best_model |
Self
|
The model that performed the best out of all possible models given the Choices of hyperparameters. |
Raises:
Type | Description |
---|---|
PlainTableError
|
If a table is passed instead of a TabularDataset. |
DatasetMissesDataError
|
If the given training set contains no data. |
FittingWithoutChoiceError
|
When trying to call this method on a model without hyperparameter choices. |
LearningError
|
If the training data contains invalid values or if the training failed. |
Source code in src/safeds/ml/classical/classification/_classifier.py
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 |
|
get_feature_names
¶
Return the names of the feature columns.
Note: The model must be fitted.
Returns:
Name | Type | Description |
---|---|---|
feature_names |
list[str]
|
The names of the feature columns. |
Raises:
Type | Description |
---|---|
ModelNotFittedError
|
If the model has not been fitted yet. |
Source code in src/safeds/ml/classical/_supervised_model.py
get_features_schema
¶
Return the schema of the feature columns.
Note: The model must be fitted.
Returns:
Name | Type | Description |
---|---|---|
feature_schema |
Schema
|
The schema of the feature columns. |
Raises:
Type | Description |
---|---|
ModelNotFittedError
|
If the model has not been fitted yet. |
Source code in src/safeds/ml/classical/_supervised_model.py
get_target_name
¶
Return the name of the target column.
Note: The model must be fitted.
Returns:
Name | Type | Description |
---|---|---|
target_name |
str
|
The name of the target column. |
Raises:
Type | Description |
---|---|
ModelNotFittedError
|
If the model has not been fitted yet. |
Source code in src/safeds/ml/classical/_supervised_model.py
get_target_type
¶
Return the type of the target column.
Note: The model must be fitted.
Returns:
Name | Type | Description |
---|---|---|
target_type |
DataType
|
The type of the target column. |
Raises:
Type | Description |
---|---|
ModelNotFittedError
|
If the model has not been fitted yet. |
Source code in src/safeds/ml/classical/_supervised_model.py
precision
¶
Compute the classifier's precision on the given data.
The precision is the proportion of positive predictions that were correct. The higher the precision, the better the classifier. Results range from 0.0 to 1.0.
Note: The model must be fitted.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
validation_or_test_set |
Table | TabularDataset
|
The validation or test set. |
required |
positive_class |
Any
|
The class to be considered positive. All other classes are considered negative. |
required |
Returns:
Name | Type | Description |
---|---|---|
precision |
float
|
The classifier's precision. |
Raises:
Type | Description |
---|---|
ModelNotFittedError
|
If the classifier has not been fitted yet. |
Source code in src/safeds/ml/classical/classification/_classifier.py
predict
¶
Predict the target values on the given dataset.
Note: The model must be fitted.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
dataset |
Table | TabularDataset
|
The dataset containing at least the features. |
required |
Returns:
Name | Type | Description |
---|---|---|
prediction |
TabularDataset
|
The given dataset with an additional column for the predicted target values. |
Raises:
Type | Description |
---|---|
ModelNotFittedError
|
If the model has not been fitted yet. |
DatasetMissesFeaturesError
|
If the dataset misses feature columns. |
PredictionError
|
If predicting with the given dataset failed. |
Source code in src/safeds/ml/classical/_supervised_model.py
recall
¶
Compute the classifier's recall on the given data.
The recall is the proportion of actual positives that were predicted correctly. The higher the recall, the better the classifier. Results range from 0.0 to 1.0.
Note: The model must be fitted.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
validation_or_test_set |
Table | TabularDataset
|
The validation or test set. |
required |
positive_class |
Any
|
The class to be considered positive. All other classes are considered negative. |
required |
Returns:
Name | Type | Description |
---|---|---|
recall |
float
|
The classifier's recall. |
Raises:
Type | Description |
---|---|
ModelNotFittedError
|
If the classifier has not been fitted yet. |
Source code in src/safeds/ml/classical/classification/_classifier.py
summarize_metrics
¶
Summarize the classifier's metrics on the given data.
Note: The model must be fitted.
Parameters:
Name | Type | Description | Default |
---|---|---|---|
validation_or_test_set |
Table | TabularDataset
|
The validation or test set. |
required |
positive_class |
Any
|
The class to be considered positive. All other classes are considered negative. |
required |
Returns:
Name | Type | Description |
---|---|---|
metrics |
Table
|
A table containing the classifier's metrics. |
Raises:
Type | Description |
---|---|
ModelNotFittedError
|
If the classifier has not been fitted yet. |