API: modeling
skyulf.modeling
Modeling module for Skyulf.
BaseModelApplier
Bases: ABC
Source code in skyulf-core/skyulf/modeling/base.py
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 | |
predict(df, model_artifact)
abstractmethod
Generates predictions.
Source code in skyulf-core/skyulf/modeling/base.py
67 68 69 70 71 72 73 | |
predict_proba(df, model_artifact)
Generates prediction probabilities if supported. Returns DataFrame where columns are classes.
Source code in skyulf-core/skyulf/modeling/base.py
75 76 77 78 79 80 81 82 | |
BaseModelCalculator
Bases: ABC
Source code in skyulf-core/skyulf/modeling/base.py
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 | |
default_params
property
Default hyperparameters for the model.
problem_type
abstractmethod
property
Returns 'classification' or 'regression'.
build_tuning_search_space(config, strategy)
Hook: let a model auto-build its tuning search space.
Returns an empty dict for plain models (the caller keeps the
user-provided space). Ensembles override this to expand their base
learners' parameter grids into nested <name>__<param> keys.
Source code in skyulf-core/skyulf/modeling/base.py
40 41 42 43 44 45 46 47 | |
fit(X, y, config, progress_callback=None, log_callback=None, validation_data=None)
abstractmethod
Trains the model. Returns the model object (serializable).
Source code in skyulf-core/skyulf/modeling/base.py
49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 | |
prepare_tuning_params(config)
Hook for structural models (e.g. ensembles) to absorb their sub-estimator selection before the tuner builds the base model.
No-op for plain models. Ensembles override this to inject the resolved
estimators (and final_estimator) into :attr:default_params so
the tuner can construct a valid meta-estimator.
Source code in skyulf-core/skyulf/modeling/base.py
30 31 32 33 34 35 36 37 38 | |
BernoulliNBApplier
Bases: SklearnApplier
Bernoulli Naive Bayes Applier.
Source code in skyulf-core/skyulf/modeling/naive_bayes.py
56 57 | |
BernoulliNBCalculator
Bases: SklearnCalculator
Bernoulli Naive Bayes Calculator.
Source code in skyulf-core/skyulf/modeling/naive_bayes.py
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 | |
CalibratedClassifierApplier
Bases: SklearnApplier
Calibrated Classifier Applier (well-calibrated predict_proba).
Source code in skyulf-core/skyulf/modeling/classification.py
86 87 | |
CalibratedClassifierCalculator
Bases: SklearnCalculator
Calibrated Classifier Calculator with a selectable base estimator.
The frontend sends base_estimator as a string key (e.g.
"random_forest"); it is resolved here into a fresh estimator instance
before CalibratedClassifierCV is constructed. Defaults to logistic
regression for backward compatibility.
Source code in skyulf-core/skyulf/modeling/classification.py
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 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 | |
HyperparameterField
dataclass
Describe a single tunable hyperparameter.
Source code in skyulf-core/skyulf/modeling/hyperparameters/_field.py
7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | |
LogisticRegressionApplier
Bases: SklearnApplier
Logistic Regression Applier.
Source code in skyulf-core/skyulf/modeling/classification.py
57 58 | |
LogisticRegressionCalculator
Bases: SklearnCalculator
Logistic Regression Calculator.
Source code in skyulf-core/skyulf/modeling/classification.py
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 | |
MultinomialNBApplier
Bases: SklearnApplier
Multinomial Naive Bayes Applier.
Source code in skyulf-core/skyulf/modeling/naive_bayes.py
21 22 | |
MultinomialNBCalculator
Bases: SklearnCalculator
Multinomial Naive Bayes Calculator.
Source code in skyulf-core/skyulf/modeling/naive_bayes.py
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 | |
RandomForestClassifierApplier
Bases: SklearnApplier
Random Forest Classifier Applier.
Source code in skyulf-core/skyulf/modeling/classification.py
174 175 | |
RandomForestClassifierCalculator
Bases: SklearnCalculator
Random Forest Classifier Calculator.
Source code in skyulf-core/skyulf/modeling/classification.py
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 | |
RandomForestRegressorApplier
Bases: SklearnApplier
Random Forest Regressor Applier.
Source code in skyulf-core/skyulf/modeling/regression.py
107 108 | |
RandomForestRegressorCalculator
Bases: SklearnCalculator
Random Forest Regressor Calculator.
Source code in skyulf-core/skyulf/modeling/regression.py
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 | |
RidgeRegressionApplier
Bases: SklearnApplier
Ridge Regression Applier.
Source code in skyulf-core/skyulf/modeling/regression.py
78 79 | |
RidgeRegressionCalculator
Bases: SklearnCalculator
Ridge Regression Calculator.
Source code in skyulf-core/skyulf/modeling/regression.py
82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 | |
SGDClassifierApplier
Bases: SklearnApplier
Stochastic Gradient Descent Classifier Applier.
Source code in skyulf-core/skyulf/modeling/classification.py
553 554 | |
SGDClassifierCalculator
Bases: SklearnCalculator
SGD Classifier Calculator.
Source code in skyulf-core/skyulf/modeling/classification.py
557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 | |
SklearnApplier
Bases: BaseModelApplier
Base applier for Scikit-Learn models.
Source code in skyulf-core/skyulf/modeling/sklearn_wrapper.py
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 | |
SklearnCalculator
Bases: BaseModelCalculator
Base calculator for Scikit-Learn models.
Source code in skyulf-core/skyulf/modeling/sklearn_wrapper.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 | |
fit(X, y, config, progress_callback=None, log_callback=None, validation_data=None)
Fit the Scikit-Learn model.
Source code in skyulf-core/skyulf/modeling/sklearn_wrapper.py
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 | |
StackingClassifierApplier
Bases: SklearnApplier
Stacking Classifier Applier (meta-learner over base classifiers).
Source code in skyulf-core/skyulf/modeling/ensemble.py
458 459 | |
StackingClassifierCalculator
Bases: _BaseEnsembleCalculator
Stacking Classifier Calculator with selectable base + final learners.
Source code in skyulf-core/skyulf/modeling/ensemble.py
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 | |
StackingRegressorApplier
Bases: SklearnApplier
Stacking Regressor Applier (meta-learner over base regressors).
Source code in skyulf-core/skyulf/modeling/ensemble.py
530 531 | |
StackingRegressorCalculator
Bases: _BaseEnsembleCalculator
Stacking Regressor Calculator with selectable base + final learners.
Source code in skyulf-core/skyulf/modeling/ensemble.py
534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 | |
StatefulEstimator
Source code in skyulf-core/skyulf/modeling/base.py
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 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 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 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 | |
cross_validate(dataset, target_column, config, n_folds=5, cv_type='k_fold', shuffle=True, random_state=42, time_column=None, progress_callback=None, log_callback=None)
Performs cross-validation on the training split.
Source code in skyulf-core/skyulf/modeling/base.py
133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 | |
evaluate(dataset, target_column, job_id='unknown')
Evaluates the model on all splits and returns a detailed report.
Source code in skyulf-core/skyulf/modeling/base.py
317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 | |
fit_predict(dataset, target_column, config, progress_callback=None, log_callback=None, job_id='unknown')
Fits the model on training data and returns predictions for all splits.
Source code in skyulf-core/skyulf/modeling/base.py
169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 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 | |
refit(dataset, target_column, config, job_id='unknown')
Refits the model on Train + Validation data and updates the artifact.
Source code in skyulf-core/skyulf/modeling/base.py
292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 | |
VotingClassifierApplier
Bases: SklearnApplier
Voting Classifier Applier (hard/soft vote over base classifiers).
Source code in skyulf-core/skyulf/modeling/ensemble.py
422 423 | |
VotingClassifierCalculator
Bases: _BaseEnsembleCalculator
Voting Classifier Calculator with selectable base learners.
Source code in skyulf-core/skyulf/modeling/ensemble.py
426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 | |
VotingRegressorApplier
Bases: SklearnApplier
Voting Regressor Applier (averaged predictions over base regressors).
Source code in skyulf-core/skyulf/modeling/ensemble.py
496 497 | |
VotingRegressorCalculator
Bases: _BaseEnsembleCalculator
Voting Regressor Calculator with selectable base learners.
Source code in skyulf-core/skyulf/modeling/ensemble.py
500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 | |
get_default_search_space(model_key, strategy='random')
Return the default search space for model_key.
For grid-based strategies (grid / halving_grid) the trimmed
GRID_SEARCH_SPACES dict is used so the cartesian product stays
manageable. All other strategies (random, halving_random,
optuna) use the richer DEFAULT_SEARCH_SPACES.
Source code in skyulf-core/skyulf/modeling/hyperparameters/_registry.py
472 473 474 475 476 477 478 479 480 481 482 | |
perform_cross_validation(calculator, applier, X, y, config, n_folds=5, cv_type='k_fold', shuffle=True, random_state=42, time_column=None, progress_callback=None, log_callback=None)
Performs K-Fold cross-validation.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
calculator
|
BaseModelCalculator
|
The model calculator (fit logic). |
required |
applier
|
BaseModelApplier
|
The model applier (predict logic). |
required |
X
|
Union[DataFrame, SkyulfDataFrame]
|
Features. |
required |
y
|
Union[Series, Any]
|
Target. |
required |
config
|
Dict[str, Any]
|
Model configuration. |
required |
n_folds
|
int
|
Number of folds. |
5
|
cv_type
|
str
|
Type of CV. |
'k_fold'
|
shuffle
|
bool
|
Whether to shuffle data before splitting (for KFold/Stratified). |
True
|
random_state
|
int
|
Random seed for shuffling. |
42
|
time_column
|
Optional[str]
|
Optional column name for sorting when using time_series_split. |
None
|
progress_callback
|
Optional[Callable[[int, int], None]]
|
Optional callback(current_fold, total_folds). |
None
|
log_callback
|
Optional[Callable[[str], None]]
|
Optional callback for logging messages. |
None
|
Returns:
| Type | Description |
|---|---|
Dict[str, Any]
|
Dict containing aggregated metrics and per-fold details. |
Source code in skyulf-core/skyulf/modeling/cross_validation.py
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 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 | |