|
2 | 2 | #' @format [R6Class] Graph |
3 | 3 | #' |
4 | 4 | #' @usage NULL |
5 | | -#' @format [`R6Class`]. |
| 5 | +#' @format [`R6Class`][R6::R6Class]. |
6 | 6 | #' |
7 | 7 | #' @description |
8 | 8 | #' A [`Graph`] is a representation of a machine learning pipeline graph. It can be *trained*, and subsequently used for *prediction*. |
|
19 | 19 | #' ``` |
20 | 20 | #' |
21 | 21 | #' @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`] |
23 | 23 | #' performs topological sorting of the [`PipeOp`]s and executes their respective `$train()` or `$predict()` functions in order, moving |
24 | 24 | #' the [`PipeOp`] results along the edges as input to other [`PipeOp`]s. |
25 | 25 | #' |
26 | 26 | #' @section Fields: |
27 | 27 | #' * `pipeops` :: named `list` of [`PipeOp`] \cr |
28 | 28 | #' 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 |
31 | 31 | #' the `$pipeops` list. `src_channel` and `dst_channel` must respectively be `$output` and `$input` channel names of the |
32 | 32 | #' respective [`PipeOp`]s. |
33 | 33 | #' * `is_trained` :: `logical(1)` \cr |
|
36 | 36 | #' Ids of the 'left-hand-side' [`PipeOp`]s that have some unconnected input channels and therefore act as [`Graph`] input layer. |
37 | 37 | #' * `rhs` :: `character` \cr |
38 | 38 | #' 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 |
40 | 40 | #' Input channels of the [`Graph`]. For each channel lists the name, input type during training, input type during prediction, |
41 | 41 | #' [`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 |
43 | 43 | #' Output channels of the [`Graph`]. For each channel lists the name, output type during training, output type during prediction, |
44 | 44 | #' [`PipeOp`] `$id` of the [`PipeOp`] the channel pertains to, and channel name as the [`PipeOp`] knows it. |
45 | 45 | #' * `packages` :: `character`\cr |
|
0 commit comments