20
20
# '
21
21
# ' @section Construction:
22
22
# ' ```
23
- # ' PipeOpEncodePL$new(id = "encodepl", param_set = ps(), param_vals = list(), packages = character(0), task_type = "Task)
23
+ # ' PipeOpEncodePL$new(id = "encodepl", param_set = ps(), param_vals = list(), packages = character(0), task_type = "Task" )
24
24
# ' ```
25
25
# ' * `id` :: `character(1)`\cr
26
26
# ' Identifier of resulting object. See `$id` slot of [`PipeOp`].
38
38
# ' `"TaskRegr"` (or another subclass introduced by other packages). Default is `"Task"`.
39
39
# '
40
40
# ' @section Input and Output Channels:
41
- # ' Input and output channels are inherited from [`PipeOpTaskPreprocSimple `].
41
+ # ' Input and output channels are inherited from [`PipeOpTaskPreproc `].
42
42
# '
43
43
# ' The output is the input [`Task`][mlr3::Task] with all affected `numeric` and `integer` columns encoded using piecewise linear encoding.
44
44
# '
45
45
# ' @section State:
46
- # ' The `$state` is a named `list` with the `$state` elements inherited from [`PipeOpTaskPreprocSimple `], as well as:
46
+ # ' The `$state` is a named `list` with the `$state` elements inherited from [`PipeOpTaskPreproc `], as well as:
47
47
# ' * `bins` :: named `list`\cr
48
- # ' Named list of numeric vectors. Each element corresponds to one of the affected feature columns and contains the
49
- # ' bin boundaries derived through `private$.get_bins()`. The element vectors are named by the respective
50
- # ' feature column.
48
+ # ' Named list of numeric vectors. Each element corresponds to and is named after one of the affected feature columns
49
+ # ' and contains the bin boundaries derived through `private$.get_bins()`.
51
50
# '
52
51
# ' @section Parameters:
53
- # ' The parameters are the parameters inherited from [`PipeOpTaskPreprocSimple `].
52
+ # ' The parameters are the parameters inherited from [`PipeOpTaskPreproc `].
54
53
# '
55
54
# ' @section Internals:
56
55
# ' `PipeOpEncodePL` is an abstract class inheriting from [`PipeOpTaskPreprocSimple`] that allows easier implementation
57
56
# ' of different binning algorithms for piecewise linear encoding. The respective binning algorithm should be implemented
58
57
# ' as `private$.get_bins()`.
59
58
# '
60
59
# ' @section Fields:
61
- # ' Only fields inherited from [`PipeOpTaskPreprocSimple`]/[`PipeOpTaskPreproc`]/[` PipeOp`].
60
+ # ' Only fields inherited from [`PipeOp`].
62
61
# '
63
62
# ' @section Methods:
64
63
# ' Methods inherited from [`PipeOpTaskPreprocSimple`]/[`PipeOpTaskPreproc`]/[`PipeOp`] as well as
@@ -172,7 +171,7 @@ encode_piecewise_linear = function(column, bins) {
172
171
# ' The `$state` is a named `list` with the `$state` elements inherited from [`PipeOpEncodePL`]/[`PipeOpTaskPreproc`].
173
172
# '
174
173
# ' @section Parameters:
175
- # ' The parameters are the parameters inherited from [`PipeOpEncodePL`]/[` PipeOpTaskPreproc`], as well as:
174
+ # ' The parameters are the parameters inherited from [`PipeOpTaskPreproc`], as well as:
176
175
# ' * `numsplits` :: `integer(1)` \cr
177
176
# ' Number of bins to create. Default is `2`.
178
177
# ' * `type` :: `integer(1)`\cr
@@ -262,8 +261,8 @@ mlr_pipeops$add("encodeplquantiles", PipeOpEncodePLQuantiles)
262
261
# ' Encodes `numeric` and `integer` feature columns using piecewise lienar encoding. For details, see documentation of
263
262
# ' `PipeOpEncodePL` or the paper referenced below.
264
263
# '
265
- # ' Bins are constructed by trainig one decision tree [`Learner`][mlr3::Learner] per feature column, taking the target column into account,
266
- # ' and using decision boundaries as bin boundaries.
264
+ # ' Bins are constructed by trainig one decision tree [`Learner`][mlr3::Learner] per feature column, taking the target
265
+ # ' column into account, and using decision boundaries as bin boundaries.
267
266
# '
268
267
# ' @section Construction:
269
268
# ' ```
@@ -289,7 +288,7 @@ mlr_pipeops$add("encodeplquantiles", PipeOpEncodePLQuantiles)
289
288
# ' The `$state` is a named `list` with the `$state` elements inherited from [`PipeOpEncodePL`]/[`PipeOpTaskPreproc`].
290
289
# '
291
290
# ' @section Parameters:
292
- # ' The parameters are the parameters inherited from [`PipeOpEncodePL`]/[` PipeOpTaskPreproc`], as well as the parameters of
291
+ # ' The parameters are the parameters inherited from [`PipeOpTaskPreproc`], as well as the parameters of
293
292
# ' the [`Learner`][mlr3::Learner] used for obtaining the bins for piecewise linear encoding.
294
293
# '
295
294
# ' @section Internals:
0 commit comments