Skip to content

Commit 5260790

Browse files
committed
fix doc links
1 parent 394d9e2 commit 5260790

File tree

149 files changed

+216
-216
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

149 files changed

+216
-216
lines changed

R/Graph.R

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
#' @format [R6Class] Graph
33
#'
44
#' @usage NULL
5-
#' @format [`R6Class`].
5+
#' @format [`R6Class`][R6::R6Class].
66
#'
77
#' @description
88
#' A [`Graph`] is a representation of a machine learning pipeline graph. It can be *trained*, and subsequently used for *prediction*.
@@ -19,15 +19,15 @@
1919
#' ```
2020
#'
2121
#' @section Internals:
22-
#' A [`Graph`] is made up of a list of [`PipeOp`]s, and a [`data.table`] of edges. Both for training and prediction, the [`Graph`]
22+
#' A [`Graph`] is made up of a list of [`PipeOp`]s, and a [`data.table`][data.table::data.table] of edges. Both for training and prediction, the [`Graph`]
2323
#' performs topological sorting of the [`PipeOp`]s and executes their respective `$train()` or `$predict()` functions in order, moving
2424
#' the [`PipeOp`] results along the edges as input to other [`PipeOp`]s.
2525
#'
2626
#' @section Fields:
2727
#' * `pipeops` :: named `list` of [`PipeOp`] \cr
2828
#' Contains all [`PipeOp`]s in the [`Graph`], named by the [`PipeOp`]'s `$id`s.
29-
#' * `edges` :: [`data.table`] with columns `src_id` (`character`), `src_channel` (`character`), `dst_id` (`character`), `dst_channel` (`character`)\cr
30-
#' Table of connections between the [`PipeOp`]s. A [`data.table`]. `src_id` and `dst_id` are `$id`s of [`PipeOp`]s that must be present in
29+
#' * `edges` :: [`data.table`][data.table::data.table] with columns `src_id` (`character`), `src_channel` (`character`), `dst_id` (`character`), `dst_channel` (`character`)\cr
30+
#' Table of connections between the [`PipeOp`]s. A [`data.table`][data.table::data.table]. `src_id` and `dst_id` are `$id`s of [`PipeOp`]s that must be present in
3131
#' the `$pipeops` list. `src_channel` and `dst_channel` must respectively be `$output` and `$input` channel names of the
3232
#' respective [`PipeOp`]s.
3333
#' * `is_trained` :: `logical(1)` \cr
@@ -36,10 +36,10 @@
3636
#' Ids of the 'left-hand-side' [`PipeOp`]s that have some unconnected input channels and therefore act as [`Graph`] input layer.
3737
#' * `rhs` :: `character` \cr
3838
#' Ids of the 'right-hand-side' [`PipeOp`]s that have some unconnected output channels and therefore act as [`Graph`] output layer.
39-
#' * `input` :: [`data.table`] with columns `name` (`character`), `train` (`character`), `predict` (`character`), `op.id` (`character`), `channel.name` (`character`)\cr
39+
#' * `input` :: [`data.table`][data.table::data.table] with columns `name` (`character`), `train` (`character`), `predict` (`character`), `op.id` (`character`), `channel.name` (`character`)\cr
4040
#' Input channels of the [`Graph`]. For each channel lists the name, input type during training, input type during prediction,
4141
#' [`PipeOp`] `$id` of the [`PipeOp`] the channel pertains to, and channel name as the [`PipeOp`] knows it.
42-
#' * `output` :: [`data.table`] with columns `name` (`character`), `train` (`character`), `predict` (`character`), `op.id` (`character`), `channel.name` (`character`)\cr
42+
#' * `output` :: [`data.table`][data.table::data.table] with columns `name` (`character`), `train` (`character`), `predict` (`character`), `op.id` (`character`), `channel.name` (`character`)\cr
4343
#' Output channels of the [`Graph`]. For each channel lists the name, output type during training, output type during prediction,
4444
#' [`PipeOp`] `$id` of the [`PipeOp`] the channel pertains to, and channel name as the [`PipeOp`] knows it.
4545
#' * `packages` :: `character`\cr

R/GraphLearner.R

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
#' @title Encapsulate a Graph as a Learner
22
#'
33
#' @name mlr_learners_graph
4-
#' @format [`R6Class`] object inheriting from [`mlr3::Learner`].
4+
#' @format [`R6Class`][R6::R6Class] object inheriting from [`mlr3::Learner`].
55
#'
66
#' @description
77
#' A [`Learner`][mlr3::Learner] that encapsulates a [`Graph`] to be used in
@@ -337,11 +337,11 @@ GraphLearner = R6Class("GraphLearner", inherit = Learner,
337337
#' This parameter is ignored when `validate` is set to `NULL`.
338338
#' By default, validation is enabled for the final `PipeOp` in the `Graph`.
339339
#' @param args_all (`list()`)\cr
340-
#' Rarely needed. A named list of parameter values that are passed to all subsequet [`set_validate()`] calls on the individual
340+
#' Rarely needed. A named list of parameter values that are passed to all subsequet [`set_validate()`][mlr3::set_validate] calls on the individual
341341
#' `PipeOp`s.
342342
#' @param args (named `list()`)\cr
343343
#' Rarely needed.
344-
#' A named list of lists, specifying additional argments to be passed to [`set_validate()`] when calling it on the individual
344+
#' A named list of lists, specifying additional argments to be passed to [`set_validate()`][mlr3::set_validate] when calling it on the individual
345345
#' `PipeOp`s.
346346
#' @param ... (any)\cr
347347
#' Currently unused.

R/LearnerAvg.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
#' @usage mlr_learners_classif.avg
44
#' @name mlr_learners_avg
55
#' @aliases mlr_learners_classif.avg
6-
#' @format [`R6Class`] object inheriting from [`mlr3::LearnerClassif`]/[`mlr3::Learner`].
6+
#' @format [`R6Class`][R6::R6Class] object inheriting from [`mlr3::LearnerClassif`]/[`mlr3::Learner`].
77
#'
88
#' @description
99
#' Computes a weighted average of inputs.
@@ -23,7 +23,7 @@
2323
#' incoming features.
2424
#'
2525
#' @section Parameters:
26-
#' The parameters are the parameters inherited from [`LearnerClassif`], as well as:
26+
#' The parameters are the parameters inherited from [`LearnerClassif`][mlr3::LearnerClassif], as well as:
2727
#' * `measure` :: [`Measure`][mlr3::Measure] | `character` \cr
2828
#' [`Measure`][mlr3::Measure] to optimize for.
2929
#' Will be converted to a [`Measure`][mlr3::Measure] in case it is `character`.

R/NO_OP.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#' @title No-Op Sentinel Used for Alternative Branching
22
#'
3-
#' @format [`R6`] object.
3+
#' @format [`R6`][R6::R6] object.
44
#'
55
#' @description
66
#' Special data type for no-ops. Distinct from `NULL` for easier debugging

R/PipeOp.R

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
#' @title PipeOp Base Class
55
#'
66
#' @usage NULL
7-
#' @format Abstract [`R6Class`].
7+
#' @format Abstract [`R6Class`][R6::R6Class].
88
#'
99
#' @description
1010
#' A [`PipeOp`] represents a transformation of a given "input" into a given "output", with two stages: "training"
@@ -51,9 +51,9 @@
5151
#' * `param_vals` :: named `list`\cr
5252
#' List of hyperparameter settings, overwriting the hyperparameter settings given in `param_set`. The
5353
#' subclass should have its own `param_vals` parameter and pass it on to `super$initialize()`. Default `list()`.
54-
#' * input :: [`data.table`] with columns `name` (`character`), `train` (`character`), `predict` (`character`)\cr
54+
#' * input :: [`data.table`][data.table::data.table] with columns `name` (`character`), `train` (`character`), `predict` (`character`)\cr
5555
#' Sets the `$input` slot of the resulting object; see description there.
56-
#' * output :: [`data.table`] with columns `name` (`character`), `train` (`character`), `predict` (`character`)\cr
56+
#' * output :: [`data.table`][data.table::data.table] with columns `name` (`character`), `train` (`character`), `predict` (`character`)\cr
5757
#' Sets the `$output` slot of the resulting object; see description there.
5858
#' * packages :: `character`\cr
5959
#' Set of all required packages for the [`PipeOp`]'s `$train` and `$predict` methods. See `$packages` slot.
@@ -92,7 +92,7 @@
9292
#' `$train()`, because `private$.train()` may theoretically be executed in a different `R`-session (e.g. for parallelization).
9393
#' `$state` should furthermore always be set to something with copy-semantics, since it is never cloned. This is a limitation
9494
#' not of [`PipeOp`] or `mlr3pipelines`, but of the way the system as a whole works, together with [`GraphLearner`] and `mlr3`.
95-
#' * input :: [`data.table`] with columns `name` (`character`), `train` (`character`), `predict` (`character`)\cr
95+
#' * input :: [`data.table`][data.table::data.table] with columns `name` (`character`), `train` (`character`), `predict` (`character`)\cr
9696
#' Input channels of [`PipeOp`]. Column `name` gives the names (and order) of values in the list given to
9797
#' `$train()` and `$predict()`. Column `train` is the (S3) class that an input object must conform to during
9898
#' training, column `predict` is the (S3) class that an input object must conform to during prediction. Types
@@ -104,7 +104,7 @@
104104
#' unpacked and the `.train()` and `.predict()` functions are called multiple times, once for each [`Multiplicity`] element.
105105
#' The type enclosed by square brackets indicates that only a [`Multiplicity`] containing values of this type are accepted.
106106
#' See [`Multiplicity`] for more information.
107-
#' * output :: [`data.table`] with columns `name` (`character`), `train` (`character`), `predict` (`character`)\cr
107+
#' * output :: [`data.table`][data.table::data.table] with columns `name` (`character`), `train` (`character`), `predict` (`character`)\cr
108108
#' Output channels of [`PipeOp`], in the order in which they will be given in the list returned by `$train` and
109109
#' `$predict` functions. Column `train` is the (S3) class that an output object must conform to during training,
110110
#' column `predict` is the (S3) class that an output object must conform to during prediction. The [`PipeOp`] checks

R/PipeOpBoxCox.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
#'
33
#' @usage NULL
44
#' @name mlr_pipeops_boxcox
5-
#' @format [`R6Class`] object inheriting from [`PipeOpTaskPreproc`]/[`PipeOp`].
5+
#' @format [`R6Class`][R6::R6Class] object inheriting from [`PipeOpTaskPreproc`]/[`PipeOp`].
66
#'
77
#' @description
88
#' Conducts a Box-Cox transformation on numeric features. The lambda parameter

R/PipeOpBranch.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
#'
33
#' @usage NULL
44
#' @name mlr_pipeops_branch
5-
#' @format [`R6Class`] object inheriting from [`PipeOp`].
5+
#' @format [`R6Class`][R6::R6Class] object inheriting from [`PipeOp`].
66
#'
77
#' @description
88
#' Perform alternative path branching: [`PipeOpBranch`] has multiple output channels

R/PipeOpChunk.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
#'
33
#' @usage NULL
44
#' @name mlr_pipeops_chunk
5-
#' @format [`R6Class`] object inheriting from [`PipeOp`].
5+
#' @format [`R6Class`][R6::R6Class] object inheriting from [`PipeOp`].
66
#'
77
#' @description
88
#' Chunks its input into `outnum` chunks.

R/PipeOpClassBalancing.R

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
#'
33
#' @usage NULL
44
#' @name mlr_pipeops_classbalancing
5-
#' @format [`R6Class`] object inheriting from [`PipeOpTaskPreproc`]/[`PipeOp`].
5+
#' @format [`R6Class`][R6::R6Class] object inheriting from [`PipeOpTaskPreproc`]/[`PipeOp`].
66
#'
77
#' @description
88
#' Both undersamples a [`Task`][mlr3::Task] to keep only a fraction of the rows of the majority class,
@@ -67,7 +67,7 @@
6767
#'
6868
#' Uses `task$filter()` to remove rows. When identical rows are added during upsampling, then the `task$row_roles$use` can *not* be used
6969
#' to duplicate rows because of \[inaudible\]; instead the `task$rbind()` function is used, and
70-
#' a new [`data.table`] is attached that contains all rows that are being duplicated exactly as many times as they are being added.
70+
#' a new [`data.table`][data.table::data.table] is attached that contains all rows that are being duplicated exactly as many times as they are being added.
7171
#'
7272
#' @section Fields:
7373
#' Only fields inherited from [`PipeOpTaskPreproc`]/[`PipeOp`].

R/PipeOpClassWeights.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
#'
33
#' @usage NULL
44
#' @name mlr_pipeops_classweights
5-
#' @format [`R6Class`] object inheriting from [`PipeOpTaskPreproc`]/[`PipeOp`].
5+
#' @format [`R6Class`][R6::R6Class] object inheriting from [`PipeOpTaskPreproc`]/[`PipeOp`].
66
#'
77
#' @description
88
#' Adds a class weight column to the [`Task`][mlr3::Task] that different [`Learner`][mlr3::Learner]s may be

0 commit comments

Comments
 (0)