diff --git a/dev/LICENSE.html b/dev/LICENSE.html index 42cf717c..77878c96 100644 --- a/dev/LICENSE.html +++ b/dev/LICENSE.html @@ -7,7 +7,7 @@ mlr3torch - 0.1.1-9000 + 0.1.2-9000 + + + + + +
+
+
+

TensorBoard Logging Callback

+ Source: R/CallbackSetTB.R +
mlr_callback_set.tb.Rd
+
+ +
+

Logs training loss, training measures, and validation measures as events. +To view them, use TensorBoard with tensorflow::tensorboard() (requires tensorflow) or the CLI.

+
+ + +
+

Details

+

Logs events at most every epoch.

+
+
+

See also

+

Other Callback: +TorchCallback, +as_torch_callback(), +as_torch_callbacks(), +callback_set(), +mlr3torch_callbacks, +mlr_callback_set, +mlr_callback_set.checkpoint, +mlr_callback_set.progress, +mlr_context_torch, +t_clbk(), +torch_callback()

+
+
+

Super class

+

mlr3torch::CallbackSet -> CallbackSetTB

+
+
+

Methods

+ +
+

Public methods

+ +

Inherited methods

+

Method new()

+

Creates a new instance of this R6 class.

+

Usage

+

CallbackSetTB$new(path, log_train_loss)

+
+ +
+

Arguments

+

path
+

(character(1))
+The path to a folder where the events are logged. +Point TensorBoard to this folder to view them.

+ + +
log_train_loss
+

(logical(1))
+Whether we log the training loss.

+ + +

+
+ +

+

Method on_epoch_end()

+

Logs the training loss, training measures, and validation measures as TensorBoard events.

+

Usage

+

CallbackSetTB$on_epoch_end()

+
+ + +

+

Method clone()

+

The objects of this class are cloneable with this method.

+

Usage

+

CallbackSetTB$clone(deep = FALSE)

+
+ +
+

Arguments

+

deep
+

Whether to make a deep clone.

+ + +

+
+ +
+ +
+ +
+ + +
+ + + + + + + diff --git a/dev/reference/mlr_context_torch.html b/dev/reference/mlr_context_torch.html index 6e79780c..e7b58033 100644 --- a/dev/reference/mlr_context_torch.html +++ b/dev/reference/mlr_context_torch.html @@ -11,7 +11,7 @@ mlr3torch - 0.1.1-9000 + 0.1.2-9000 + + + + + +
+
+
+

1D Adaptive Average Pooling

+ Source: R/PipeOpTorchAdaptiveAvgPool.R +
mlr_pipeops_nn_adaptive_avg_pool1d.Rd
+
+ +
+

Applies a 1D adaptive average pooling over an input signal composed of +several input planes.

+
+ + +
+

Input and Output Channels

+ + +

One input channel called "input" and one output channel called "output". +For an explanation see PipeOpTorch.

+
+
+

State

+ + +

The state is the value calculated by the public method $shapes_out().

+
+
+

Credit

+ + +

Part of this documentation have been copied or adapted from the documentation of torch.

+
+
+

Parameters

+ + +

  • output_size :: integer()
    +The target output size. A single number.

    • +
+
+

Internals

+ + +

Calls nn_adaptive_avg_pool1d() during training.

+
+
+

See also

+

Other PipeOps: +mlr_pipeops_nn_adaptive_avg_pool2d, +mlr_pipeops_nn_adaptive_avg_pool3d, +mlr_pipeops_nn_avg_pool1d, +mlr_pipeops_nn_avg_pool2d, +mlr_pipeops_nn_avg_pool3d, +mlr_pipeops_nn_batch_norm1d, +mlr_pipeops_nn_batch_norm2d, +mlr_pipeops_nn_batch_norm3d, +mlr_pipeops_nn_block, +mlr_pipeops_nn_celu, +mlr_pipeops_nn_conv1d, +mlr_pipeops_nn_conv2d, +mlr_pipeops_nn_conv3d, +mlr_pipeops_nn_conv_transpose1d, +mlr_pipeops_nn_conv_transpose2d, +mlr_pipeops_nn_conv_transpose3d, +mlr_pipeops_nn_dropout, +mlr_pipeops_nn_elu, +mlr_pipeops_nn_flatten, +mlr_pipeops_nn_gelu, +mlr_pipeops_nn_glu, +mlr_pipeops_nn_hardshrink, +mlr_pipeops_nn_hardsigmoid, +mlr_pipeops_nn_hardtanh, +mlr_pipeops_nn_head, +mlr_pipeops_nn_layer_norm, +mlr_pipeops_nn_leaky_relu, +mlr_pipeops_nn_linear, +mlr_pipeops_nn_log_sigmoid, +mlr_pipeops_nn_max_pool1d, +mlr_pipeops_nn_max_pool2d, +mlr_pipeops_nn_max_pool3d, +mlr_pipeops_nn_merge, +mlr_pipeops_nn_merge_cat, +mlr_pipeops_nn_merge_prod, +mlr_pipeops_nn_merge_sum, +mlr_pipeops_nn_prelu, +mlr_pipeops_nn_relu, +mlr_pipeops_nn_relu6, +mlr_pipeops_nn_reshape, +mlr_pipeops_nn_rrelu, +mlr_pipeops_nn_selu, +mlr_pipeops_nn_sigmoid, +mlr_pipeops_nn_softmax, +mlr_pipeops_nn_softplus, +mlr_pipeops_nn_softshrink, +mlr_pipeops_nn_softsign, +mlr_pipeops_nn_squeeze, +mlr_pipeops_nn_tanh, +mlr_pipeops_nn_tanhshrink, +mlr_pipeops_nn_threshold, +mlr_pipeops_nn_unsqueeze, +mlr_pipeops_torch_ingress, +mlr_pipeops_torch_ingress_categ, +mlr_pipeops_torch_ingress_ltnsr, +mlr_pipeops_torch_ingress_num, +mlr_pipeops_torch_loss, +mlr_pipeops_torch_model, +mlr_pipeops_torch_model_classif, +mlr_pipeops_torch_model_regr

+
+
+

Super classes

+

mlr3pipelines::PipeOp -> mlr3torch::PipeOpTorch -> mlr3torch::PipeOpTorchAdaptiveAvgPool -> PipeOpTorchAdaptiveAvgPool1D

+
+
+

Methods

+ +
+

Public methods

+ +

Inherited methods

+

Method new()

+

Creates a new instance of this R6 class.

+

Usage

+

PipeOpTorchAdaptiveAvgPool1D$new(
+  id = "nn_adaptive_avg_pool1d",
+  param_vals = list()
+)

+
+ +
+

Arguments

+

id
+

(character(1))
+Identifier of the resulting object.

+ + +
param_vals
+

(list())
+List of hyperparameter settings, overwriting the hyperparameter settings that would +otherwise be set during construction.

+ + +

+
+ +

+

Method clone()

+

The objects of this class are cloneable with this method.

+

Usage

+

PipeOpTorchAdaptiveAvgPool1D$clone(deep = FALSE)

+
+ +
+

Arguments

+

deep
+

Whether to make a deep clone.

+ + +

+
+ +
+ +
+ +
+

Examples

+ 
# Construct the PipeOp
+pipeop = po("nn_adaptive_avg_pool1d")
+pipeop
+#> PipeOp: <nn_adaptive_avg_pool1d> (not trained)
+#> values: <list()>
+#> Input channels <name [train type, predict type]>:
+#>   input [ModelDescriptor,Task]
+#> Output channels <name [train type, predict type]>:
+#>   output [ModelDescriptor,Task]
+# The available parameters
+pipeop$param_set
+#> <ParamSet(1)>
+#>             id    class lower upper nlevels        default  value
+#>         <char>   <char> <num> <num>   <num>         <list> <list>
+#> 1: output_size ParamUty    NA    NA     Inf <NoDefault[0]> [NULL]
+
+
+
+ + +
+ + + + + + + diff --git a/dev/reference/mlr_pipeops_nn_adaptive_avg_pool2d.html b/dev/reference/mlr_pipeops_nn_adaptive_avg_pool2d.html new file mode 100644 index 00000000..12834e2e --- /dev/null +++ b/dev/reference/mlr_pipeops_nn_adaptive_avg_pool2d.html @@ -0,0 +1,258 @@ + +2D Adaptive Average Pooling — mlr_pipeops_nn_adaptive_avg_pool2d • mlr3torch + Skip to contents + + +
+
+
+

2D Adaptive Average Pooling

+ Source: R/PipeOpTorchAdaptiveAvgPool.R +
mlr_pipeops_nn_adaptive_avg_pool2d.Rd
+
+ +
+

Applies a 2D adaptive average pooling over an input signal composed of +several input planes.

+
+ + +
+

Input and Output Channels

+ + +

One input channel called "input" and one output channel called "output". +For an explanation see PipeOpTorch.

+
+
+

State

+ + +

The state is the value calculated by the public method $shapes_out().

+
+
+

Credit

+ + +

Part of this documentation have been copied or adapted from the documentation of torch.

+
+
+

Parameters

+ + +

  • output_size :: integer()
    +The target output size. Can be a single number or a vector.

    • +
+
+

Internals

+ + +

Calls nn_adaptive_avg_pool2d() during training.

+
+
+

See also

+

Other PipeOps: +mlr_pipeops_nn_adaptive_avg_pool1d, +mlr_pipeops_nn_adaptive_avg_pool3d, +mlr_pipeops_nn_avg_pool1d, +mlr_pipeops_nn_avg_pool2d, +mlr_pipeops_nn_avg_pool3d, +mlr_pipeops_nn_batch_norm1d, +mlr_pipeops_nn_batch_norm2d, +mlr_pipeops_nn_batch_norm3d, +mlr_pipeops_nn_block, +mlr_pipeops_nn_celu, +mlr_pipeops_nn_conv1d, +mlr_pipeops_nn_conv2d, +mlr_pipeops_nn_conv3d, +mlr_pipeops_nn_conv_transpose1d, +mlr_pipeops_nn_conv_transpose2d, +mlr_pipeops_nn_conv_transpose3d, +mlr_pipeops_nn_dropout, +mlr_pipeops_nn_elu, +mlr_pipeops_nn_flatten, +mlr_pipeops_nn_gelu, +mlr_pipeops_nn_glu, +mlr_pipeops_nn_hardshrink, +mlr_pipeops_nn_hardsigmoid, +mlr_pipeops_nn_hardtanh, +mlr_pipeops_nn_head, +mlr_pipeops_nn_layer_norm, +mlr_pipeops_nn_leaky_relu, +mlr_pipeops_nn_linear, +mlr_pipeops_nn_log_sigmoid, +mlr_pipeops_nn_max_pool1d, +mlr_pipeops_nn_max_pool2d, +mlr_pipeops_nn_max_pool3d, +mlr_pipeops_nn_merge, +mlr_pipeops_nn_merge_cat, +mlr_pipeops_nn_merge_prod, +mlr_pipeops_nn_merge_sum, +mlr_pipeops_nn_prelu, +mlr_pipeops_nn_relu, +mlr_pipeops_nn_relu6, +mlr_pipeops_nn_reshape, +mlr_pipeops_nn_rrelu, +mlr_pipeops_nn_selu, +mlr_pipeops_nn_sigmoid, +mlr_pipeops_nn_softmax, +mlr_pipeops_nn_softplus, +mlr_pipeops_nn_softshrink, +mlr_pipeops_nn_softsign, +mlr_pipeops_nn_squeeze, +mlr_pipeops_nn_tanh, +mlr_pipeops_nn_tanhshrink, +mlr_pipeops_nn_threshold, +mlr_pipeops_nn_unsqueeze, +mlr_pipeops_torch_ingress, +mlr_pipeops_torch_ingress_categ, +mlr_pipeops_torch_ingress_ltnsr, +mlr_pipeops_torch_ingress_num, +mlr_pipeops_torch_loss, +mlr_pipeops_torch_model, +mlr_pipeops_torch_model_classif, +mlr_pipeops_torch_model_regr

+
+
+

Super classes

+

mlr3pipelines::PipeOp -> mlr3torch::PipeOpTorch -> mlr3torch::PipeOpTorchAdaptiveAvgPool -> PipeOpTorchAdaptiveAvgPool2D

+
+
+

Methods

+ +
+

Public methods

+ +

Inherited methods

+

Method new()

+

Creates a new instance of this R6 class.

+

Usage

+

PipeOpTorchAdaptiveAvgPool2D$new(
+  id = "nn_adaptive_avg_pool2d",
+  param_vals = list()
+)

+
+ +
+

Arguments

+

id
+

(character(1))
+Identifier of the resulting object.

+ + +
param_vals
+

(list())
+List of hyperparameter settings, overwriting the hyperparameter settings that would +otherwise be set during construction.

+ + +

+
+ +

+

Method clone()

+

The objects of this class are cloneable with this method.

+

Usage

+

PipeOpTorchAdaptiveAvgPool2D$clone(deep = FALSE)

+
+ +
+

Arguments

+

deep
+

Whether to make a deep clone.

+ + +

+
+ +
+ +
+ +
+

Examples

+ 
# Construct the PipeOp
+pipeop = po("nn_adaptive_avg_pool2d")
+pipeop
+#> PipeOp: <nn_adaptive_avg_pool2d> (not trained)
+#> values: <list()>
+#> Input channels <name [train type, predict type]>:
+#>   input [ModelDescriptor,Task]
+#> Output channels <name [train type, predict type]>:
+#>   output [ModelDescriptor,Task]
+# The available parameters
+pipeop$param_set
+#> <ParamSet(1)>
+#>             id    class lower upper nlevels        default  value
+#>         <char>   <char> <num> <num>   <num>         <list> <list>
+#> 1: output_size ParamUty    NA    NA     Inf <NoDefault[0]> [NULL]
+
+
+
+ + +
+ + + + + + + diff --git a/dev/reference/mlr_pipeops_nn_adaptive_avg_pool3d.html b/dev/reference/mlr_pipeops_nn_adaptive_avg_pool3d.html new file mode 100644 index 00000000..3839097e --- /dev/null +++ b/dev/reference/mlr_pipeops_nn_adaptive_avg_pool3d.html @@ -0,0 +1,258 @@ + +3D Adaptive Average Pooling — mlr_pipeops_nn_adaptive_avg_pool3d • mlr3torch + Skip to contents + + +
+
+
+

3D Adaptive Average Pooling

+ Source: R/PipeOpTorchAdaptiveAvgPool.R +
mlr_pipeops_nn_adaptive_avg_pool3d.Rd
+
+ +
+

Applies a 3D adaptive average pooling over an input signal composed of +several input planes.

+
+ + +
+

Input and Output Channels

+ + +

One input channel called "input" and one output channel called "output". +For an explanation see PipeOpTorch.

+
+
+

State

+ + +

The state is the value calculated by the public method $shapes_out().

+
+
+

Credit

+ + +

Part of this documentation have been copied or adapted from the documentation of torch.

+
+
+

Parameters

+ + +

  • output_size :: integer()
    +The target output size. Can be a single number or a vector.

    • +
+
+

Internals

+ + +

Calls nn_adaptive_avg_pool3d() during training.

+
+
+

See also

+

Other PipeOps: +mlr_pipeops_nn_adaptive_avg_pool1d, +mlr_pipeops_nn_adaptive_avg_pool2d, +mlr_pipeops_nn_avg_pool1d, +mlr_pipeops_nn_avg_pool2d, +mlr_pipeops_nn_avg_pool3d, +mlr_pipeops_nn_batch_norm1d, +mlr_pipeops_nn_batch_norm2d, +mlr_pipeops_nn_batch_norm3d, +mlr_pipeops_nn_block, +mlr_pipeops_nn_celu, +mlr_pipeops_nn_conv1d, +mlr_pipeops_nn_conv2d, +mlr_pipeops_nn_conv3d, +mlr_pipeops_nn_conv_transpose1d, +mlr_pipeops_nn_conv_transpose2d, +mlr_pipeops_nn_conv_transpose3d, +mlr_pipeops_nn_dropout, +mlr_pipeops_nn_elu, +mlr_pipeops_nn_flatten, +mlr_pipeops_nn_gelu, +mlr_pipeops_nn_glu, +mlr_pipeops_nn_hardshrink, +mlr_pipeops_nn_hardsigmoid, +mlr_pipeops_nn_hardtanh, +mlr_pipeops_nn_head, +mlr_pipeops_nn_layer_norm, +mlr_pipeops_nn_leaky_relu, +mlr_pipeops_nn_linear, +mlr_pipeops_nn_log_sigmoid, +mlr_pipeops_nn_max_pool1d, +mlr_pipeops_nn_max_pool2d, +mlr_pipeops_nn_max_pool3d, +mlr_pipeops_nn_merge, +mlr_pipeops_nn_merge_cat, +mlr_pipeops_nn_merge_prod, +mlr_pipeops_nn_merge_sum, +mlr_pipeops_nn_prelu, +mlr_pipeops_nn_relu, +mlr_pipeops_nn_relu6, +mlr_pipeops_nn_reshape, +mlr_pipeops_nn_rrelu, +mlr_pipeops_nn_selu, +mlr_pipeops_nn_sigmoid, +mlr_pipeops_nn_softmax, +mlr_pipeops_nn_softplus, +mlr_pipeops_nn_softshrink, +mlr_pipeops_nn_softsign, +mlr_pipeops_nn_squeeze, +mlr_pipeops_nn_tanh, +mlr_pipeops_nn_tanhshrink, +mlr_pipeops_nn_threshold, +mlr_pipeops_nn_unsqueeze, +mlr_pipeops_torch_ingress, +mlr_pipeops_torch_ingress_categ, +mlr_pipeops_torch_ingress_ltnsr, +mlr_pipeops_torch_ingress_num, +mlr_pipeops_torch_loss, +mlr_pipeops_torch_model, +mlr_pipeops_torch_model_classif, +mlr_pipeops_torch_model_regr

+
+
+

Super classes

+

mlr3pipelines::PipeOp -> mlr3torch::PipeOpTorch -> mlr3torch::PipeOpTorchAdaptiveAvgPool -> PipeOpTorchAdaptiveAvgPool3D

+
+
+

Methods

+ +
+

Public methods

+ +

Inherited methods

+

Method new()

+

Creates a new instance of this R6 class.

+

Usage

+

PipeOpTorchAdaptiveAvgPool3D$new(
+  id = "nn_adaptive_avg_pool3d",
+  param_vals = list()
+)

+
+ +
+

Arguments

+

id
+

(character(1))
+Identifier of the resulting object.

+ + +
param_vals
+

(list())
+List of hyperparameter settings, overwriting the hyperparameter settings that would +otherwise be set during construction.

+ + +

+
+ +

+

Method clone()

+

The objects of this class are cloneable with this method.

+

Usage

+

PipeOpTorchAdaptiveAvgPool3D$clone(deep = FALSE)

+
+ +
+

Arguments

+

deep
+

Whether to make a deep clone.

+ + +

+
+ +
+ +
+ +
+

Examples

+ 
# Construct the PipeOp
+pipeop = po("nn_adaptive_avg_pool3d")
+pipeop
+#> PipeOp: <nn_adaptive_avg_pool3d> (not trained)
+#> values: <list()>
+#> Input channels <name [train type, predict type]>:
+#>   input [ModelDescriptor,Task]
+#> Output channels <name [train type, predict type]>:
+#>   output [ModelDescriptor,Task]
+# The available parameters
+pipeop$param_set
+#> <ParamSet(1)>
+#>             id    class lower upper nlevels        default  value
+#>         <char>   <char> <num> <num>   <num>         <list> <list>
+#> 1: output_size ParamUty    NA    NA     Inf <NoDefault[0]> [NULL]
+
+
+
+ + +
+ + + + + + + diff --git a/dev/reference/mlr_pipeops_nn_avg_pool1d.html b/dev/reference/mlr_pipeops_nn_avg_pool1d.html index 3b2efb6e..1358bdea 100644 --- a/dev/reference/mlr_pipeops_nn_avg_pool1d.html +++ b/dev/reference/mlr_pipeops_nn_avg_pool1d.html @@ -1,7 +1,7 @@ -1D Average Pooling — mlr_pipeops_nn_avg_pool1d • mlr3torch +1D Average Pooling — mlr_pipeops_nn_avg_pool1d • mlr3torch Skip to contents @@ -9,7 +9,7 @@ mlr3torch - 0.1.1-9000 + 0.1.2-9000