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/chapters/chapter2/data_and_basic_modeling.html#sec-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', predict_raw = 'FALSE'

# 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 = 
#> 
#>         -0.6929 (normalized) V1
#>  +      -2.9778 (normalized) V10
#>  +      -1.3662 (normalized) V11
#>  +      -2.9333 (normalized) V12
#>  +      -2.6163 (normalized) V13
#>  +       0.5545 (normalized) V14
#>  +       0.4429 (normalized) V15
#>  +       0.0594 (normalized) V16
#>  +       1.7508 (normalized) V17
#>  +       1.0082 (normalized) V18
#>  +       0.5826 (normalized) V19
#>  +       0.0796 (normalized) V2
#>  +      -1.5583 (normalized) V20
#>  +      -1.877  (normalized) V21
#>  +       0.7042 (normalized) V22
#>  +      -0.8586 (normalized) V23
#>  +      -2.1332 (normalized) V24
#>  +       1.8155 (normalized) V25
#>  +       2.1826 (normalized) V26
#>  +      -0.6151 (normalized) V27
#>  +      -1.6434 (normalized) V28
#>  +       0.969  (normalized) V29
#>  +       0.7059 (normalized) V3
#>  +      -0.5582 (normalized) V30
#>  +       1.641  (normalized) V31
#>  +      -0.6627 (normalized) V32
#>  +      -0.5789 (normalized) V33
#>  +       0.3926 (normalized) V34
#>  +      -0.8211 (normalized) V35
#>  +       2.4997 (normalized) V36
#>  +       1.6018 (normalized) V37
#>  +      -1.2115 (normalized) V38
#>  +       0.1785 (normalized) V39
#>  +      -1.1016 (normalized) V4
#>  +       3.2228 (normalized) V40
#>  +      -1.8645 (normalized) V41
#>  +       0.7194 (normalized) V42
#>  +      -0.7358 (normalized) V43
#>  +      -0.7054 (normalized) V44
#>  +      -1.4346 (normalized) V45
#>  +      -0.7932 (normalized) V46
#>  +      -0.0772 (normalized) V47
#>  +      -2.697  (normalized) V48
#>  +      -3.6029 (normalized) V49
#>  +      -1.4704 (normalized) V5
#>  +       3.7386 (normalized) V50
#>  +      -1.8197 (normalized) V51
#>  +      -2.168  (normalized) V52
#>  +      -0.2096 (normalized) V53
#>  +      -0.2535 (normalized) V54
#>  +       3.0108 (normalized) V55
#>  +       1.0681 (normalized) V56
#>  +       0.3644 (normalized) V57
#>  +      -0.9317 (normalized) V58
#>  +      -2.1748 (normalized) V59
#>  +       0.872  (normalized) V6
#>  +       0.6002 (normalized) V60
#>  +       2.345  (normalized) V7
#>  +       1.7855 (normalized) V8
#>  +      -2.7268 (normalized) V9
#>  +       2.28  


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

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