Skip to content

Commit c1f3e99

Browse files
committed
Small docs changes
1 parent 1beef36 commit c1f3e99

File tree

4 files changed

+22
-24
lines changed

4 files changed

+22
-24
lines changed

R/PipeOpEncodePL.R

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
#'
2121
#' @section Construction:
2222
#' ```
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")
2424
#' ```
2525
#' * `id` :: `character(1)`\cr
2626
#' Identifier of resulting object. See `$id` slot of [`PipeOp`].
@@ -38,27 +38,26 @@
3838
#' `"TaskRegr"` (or another subclass introduced by other packages). Default is `"Task"`.
3939
#'
4040
#' @section Input and Output Channels:
41-
#' Input and output channels are inherited from [`PipeOpTaskPreprocSimple`].
41+
#' Input and output channels are inherited from [`PipeOpTaskPreproc`].
4242
#'
4343
#' The output is the input [`Task`][mlr3::Task] with all affected `numeric` and `integer` columns encoded using piecewise linear encoding.
4444
#'
4545
#' @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:
4747
#' * `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()`.
5150
#'
5251
#' @section Parameters:
53-
#' The parameters are the parameters inherited from [`PipeOpTaskPreprocSimple`].
52+
#' The parameters are the parameters inherited from [`PipeOpTaskPreproc`].
5453
#'
5554
#' @section Internals:
5655
#' `PipeOpEncodePL` is an abstract class inheriting from [`PipeOpTaskPreprocSimple`] that allows easier implementation
5756
#' of different binning algorithms for piecewise linear encoding. The respective binning algorithm should be implemented
5857
#' as `private$.get_bins()`.
5958
#'
6059
#' @section Fields:
61-
#' Only fields inherited from [`PipeOpTaskPreprocSimple`]/[`PipeOpTaskPreproc`]/[`PipeOp`].
60+
#' Only fields inherited from [`PipeOp`].
6261
#'
6362
#' @section Methods:
6463
#' Methods inherited from [`PipeOpTaskPreprocSimple`]/[`PipeOpTaskPreproc`]/[`PipeOp`] as well as
@@ -172,7 +171,7 @@ encode_piecewise_linear = function(column, bins) {
172171
#' The `$state` is a named `list` with the `$state` elements inherited from [`PipeOpEncodePL`]/[`PipeOpTaskPreproc`].
173172
#'
174173
#' @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:
176175
#' * `numsplits` :: `integer(1)` \cr
177176
#' Number of bins to create. Default is `2`.
178177
#' * `type` :: `integer(1)`\cr
@@ -262,8 +261,8 @@ mlr_pipeops$add("encodeplquantiles", PipeOpEncodePLQuantiles)
262261
#' Encodes `numeric` and `integer` feature columns using piecewise lienar encoding. For details, see documentation of
263262
#' `PipeOpEncodePL` or the paper referenced below.
264263
#'
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.
267266
#'
268267
#' @section Construction:
269268
#' ```
@@ -289,7 +288,7 @@ mlr_pipeops$add("encodeplquantiles", PipeOpEncodePLQuantiles)
289288
#' The `$state` is a named `list` with the `$state` elements inherited from [`PipeOpEncodePL`]/[`PipeOpTaskPreproc`].
290289
#'
291290
#' @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
293292
#' the [`Learner`][mlr3::Learner] used for obtaining the bins for piecewise linear encoding.
294293
#'
295294
#' @section Internals:

man/mlr_pipeops_encodepl.Rd

Lines changed: 7 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/mlr_pipeops_encodeplquantiles.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/mlr_pipeops_encodepltree.Rd

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)