Classification Stochastic Gradient Descent Learner

Stochastic Gradient Descent for learning various linear models. Calls RWeka::make_Weka_classifier() from RWeka.

Initial parameter values

• F:

  • Has only 2 out of 5 original loss functions: 0 = hinge loss (SVM) and 1 = log loss (logistic regression) with 0 (hinge loss) still being the default

  • Reason for change: this learner should only contain loss functions appropriate for classification tasks

Custom mlr3 parameters

• output_debug_info:

  • original id: output-debug-info

• do_not_check_capabilities:

  • original id: do-not-check-capabilities

• num_decimal_places:

  • original id: num-decimal-places

• batch_size:

  • original id: batch-size

• Reason for change: This learner contains changed ids of the following control arguments since their ids contain irregular pattern

Dictionary

This Learner can be instantiated via lrn():

lrn("classif.sgd")

Meta Information

• Task type: “classif”

• Predict Types: “response”, “prob”

• Feature Types: “logical”, “integer”, “numeric”, “factor”, “ordered”

• Required Packages: mlr3, RWeka

Parameters

Id	Type	Default	Levels	Range
subset	untyped	-		-
na.action	untyped	-		-
F	character	0	0, 1	-
L	numeric	0.01		\((-\infty, \infty)\)
R	numeric	1e-04		\((-\infty, \infty)\)
E	integer	500		\((-\infty, \infty)\)
C	numeric	0.001		\((-\infty, \infty)\)
N	logical	-	TRUE, FALSE	-
M	logical	-	TRUE, FALSE	-
S	integer	1		\((-\infty, \infty)\)
output_debug_info	logical	FALSE	TRUE, FALSE	-
do_not_check_capabilities	logical	FALSE	TRUE, FALSE	-
num_decimal_places	integer	2		\([1, \infty)\)
batch_size	integer	100		\([1, \infty)\)
options	untyped	NULL		-

See also

• Dictionary of Learners: mlr3::mlr_learners.

• as.data.table(mlr_learners) for a table of available Learners in the running session (depending on the loaded packages).

• Chapter in the mlr3book: https://mlr3book.mlr-org.com/basics.html#learners

• mlr3learners for a selection of recommended learners.

• mlr3cluster for unsupervised clustering learners.

• mlr3pipelines to combine learners with pre- and postprocessing steps.

• mlr3tuning for tuning of hyperparameters, mlr3tuningspaces for established default tuning spaces.

Author

damirpolat

Super classes

mlr3::Learner -> mlr3::LearnerClassif -> LearnerClassifSGD

Active bindings

marshaled

(logical(1))
Whether the learner has been marshaled.

Methods

Public methods

• LearnerClassifSGD$new()

• LearnerClassifSGD$marshal()

• LearnerClassifSGD$unmarshal()

• LearnerClassifSGD$clone()

Inherited methods

• mlr3::Learner$base_learner()
• mlr3::Learner$configure()
• mlr3::Learner$encapsulate()
• mlr3::Learner$format()
• mlr3::Learner$help()
• mlr3::Learner$predict()
• mlr3::Learner$predict_newdata()
• mlr3::Learner$print()
• mlr3::Learner$reset()
• mlr3::Learner$selected_features()
• mlr3::Learner$train()
• mlr3::LearnerClassif$predict_newdata_fast()

---

Method new()

Creates a new instance of this R6 class.

Usage

LearnerClassifSGD$new()

---

Method marshal()

Marshal the learner's model.

Usage

LearnerClassifSGD$marshal(...)

Arguments

...

(any)
Additional arguments passed to mlr3::marshal_model().

---

Method unmarshal()

Unmarshal the learner's model.

Usage

LearnerClassifSGD$unmarshal(...)

Arguments

...

(any)
Additional arguments passed to mlr3::unmarshal_model().

---

Method clone()

The objects of this class are cloneable with this method.

Usage

LearnerClassifSGD$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

Examples

# Define the Learner
learner = lrn("classif.sgd")
print(learner)
#> 
#> ── <LearnerClassifSGD> (classif.sgd): Stochastic Gradient Descent ──────────────
#> • Model: -
#> • Parameters: F=0
#> • Packages: mlr3 and RWeka
#> • Predict Types: [response] and prob
#> • Feature Types: logical, integer, numeric, factor, and ordered
#> • Encapsulation: none (fallback: -)
#> • Properties: marshal, missings, and twoclass
#> • Other settings: use_weights = 'error'

# Define a Task
task = tsk("sonar")

# Create train and test set
ids = partition(task)

# Train the learner on the training ids
learner$train(task, row_ids = ids$train)

print(learner$model)
#> Loss function: Hinge loss (SVM)
#> 
#> Class = 
#> 
#>         -1.9956 (normalized) V1
#>  +      -0.5195 (normalized) V10
#>  +      -3.5115 (normalized) V11
#>  +      -2.6341 (normalized) V12
#>  +       0.3082 (normalized) V13
#>  +       0.8668 (normalized) V14
#>  +       0.4737 (normalized) V15
#>  +       2.4372 (normalized) V16
#>  +      -0.7196 (normalized) V17
#>  +      -0.2447 (normalized) V18
#>  +      -0.7426 (normalized) V19
#>  +      -0.2447 (normalized) V2
#>  +      -1.0591 (normalized) V20
#>  +       0.9637 (normalized) V21
#>  +       0.6241 (normalized) V22
#>  +      -2.5258 (normalized) V23
#>  +      -0.8985 (normalized) V24
#>  +       1.1707 (normalized) V25
#>  +      -0.3119 (normalized) V26
#>  +       0.1871 (normalized) V27
#>  +       0.3626 (normalized) V28
#>  +      -0.1613 (normalized) V29
#>  +       1.4386 (normalized) V3
#>  +      -2.8393 (normalized) V30
#>  +       4.2214 (normalized) V31
#>  +       0.0269 (normalized) V32
#>  +      -1.3133 (normalized) V33
#>  +       0.0884 (normalized) V34
#>  +      -0.0661 (normalized) V35
#>  +       2.3219 (normalized) V36
#>  +       2.2007 (normalized) V37
#>  +      -0.6376 (normalized) V38
#>  +      -0.231  (normalized) V39
#>  +      -1.6816 (normalized) V4
#>  +       1.9633 (normalized) V40
#>  +       1.3852 (normalized) V41
#>  +       0.5146 (normalized) V42
#>  +      -1.3267 (normalized) V43
#>  +      -2.0206 (normalized) V44
#>  +      -2.3865 (normalized) V45
#>  +      -0.6068 (normalized) V46
#>  +      -0.9508 (normalized) V47
#>  +      -2.1623 (normalized) V48
#>  +      -2.5293 (normalized) V49
#>  +       1.1493 (normalized) V5
#>  +       3.2532 (normalized) V50
#>  +      -3.2822 (normalized) V51
#>  +      -2.4346 (normalized) V52
#>  +       0.4827 (normalized) V53
#>  +      -1.5447 (normalized) V54
#>  +      -0.1114 (normalized) V55
#>  +      -0.318  (normalized) V56
#>  +       2.2486 (normalized) V57
#>  +      -0.5926 (normalized) V58
#>  +      -1.772  (normalized) V59
#>  +       0.4789 (normalized) V6
#>  +       0.9509 (normalized) V60
#>  +       3.6529 (normalized) V7
#>  +      -0.6585 (normalized) V8
#>  +      -1.393  (normalized) V9
#>  +       2.64  


# Make predictions for the test rows
predictions = learner$predict(task, row_ids = ids$test)

# Score the predictions
predictions$score()
#> classif.ce 
#>  0.2173913