Package index

Package

mlr3torch mlr3torch-package

mlr3torch: Deep Learning with 'mlr3'

Learners

mlr_learners.ft_transformer LearnerTorchFTTransformer

FT-Transformer

mlr_learners.mlp LearnerTorchMLP

Multi Layer Perceptron

mlr_learners.module LearnerTorchModule

Learner Torch Module

mlr_learners.tab_resnet LearnerTorchTabResNet

Tabular ResNet

mlr_learners.torch_featureless LearnerTorchFeatureless

Featureless Torch Learner

mlr_learners.torchvision LearnerTorchVision

AlexNet Image Classifier

mlr_learners_torch LearnerTorch

Base Class for Torch Learners

mlr_learners_torch_image LearnerTorchImage

Image Learner

mlr_learners_torch_model LearnerTorchModel

Learner Torch Model

Tasks

mlr_tasks_cifar mlr_tasks_cifar10 mlr_tasks_cifar100

CIFAR Classification Tasks

mlr_tasks_lazy_iris

Iris Classification Task

mlr_tasks_melanoma

Melanoma Image classification

mlr_tasks_mnist

MNIST Image classification

mlr_tasks_tiny_imagenet

Tiny ImageNet Classification Task

mlr_backends_lazy DataBackendLazy

Lazy Data Backend

Network Building Blocks

ModelDescriptor()

Represent a Model with Meta-Info

model_descriptor_to_learner()

Create a Torch Learner from a ModelDescriptor

model_descriptor_to_module()

Create a nn_graph from ModelDescriptor

model_descriptor_union()

Union of ModelDescriptors

mlr_pipeops_module PipeOpModule

Class for Torch Module Wrappers

TorchIngressToken()

Torch Ingress Token

ingress_categ()

Ingress Token for Categorical Features

ingress_ltnsr()

Ingress Token for Lazy Tensor Feature

ingress_num()

Ingress Token for Numeric Features

mlr_pipeops_torch PipeOpTorch

Base Class for Torch Module Constructor Wrappers

mlr_pipeops_torch_ingress PipeOpTorchIngress

Entrypoint to Torch Network

mlr_pipeops_torch_model PipeOpTorchModel

PipeOp Torch Model

mlr_pipeops_torch_model_classif PipeOpTorchModelClassif

PipeOp Torch Classifier

mlr_pipeops_torch_model_regr PipeOpTorchModelRegr

Torch Regression Model

batchgetter_categ()

Batchgetter for Categorical data

batchgetter_num()

Batchgetter for Numeric Data

mlr_pipeops_torch_ingress_categ PipeOpTorchIngressCategorical

Torch Entry Point for Categorical Features

mlr_pipeops_torch_ingress_ltnsr PipeOpTorchIngressLazyTensor

Ingress for Lazy Tensor

mlr_pipeops_torch_ingress_num PipeOpTorchIngressNumeric

Torch Entry Point for Numeric Features

mlr_pipeops_torch_loss PipeOpTorchLoss

Loss Configuration

mlr_pipeops_torch_optimizer PipeOpTorchOptimizer

Optimizer Configuration

mlr_pipeops_torch_callbacks PipeOpTorchCallbacks

Callback Configuration

Network Layers

mlr_pipeops_nn_adaptive_avg_pool1d PipeOpTorchAdaptiveAvgPool1D

1D Adaptive Average Pooling

mlr_pipeops_nn_adaptive_avg_pool2d PipeOpTorchAdaptiveAvgPool2D

2D Adaptive Average Pooling

mlr_pipeops_nn_adaptive_avg_pool3d PipeOpTorchAdaptiveAvgPool3D

3D Adaptive Average Pooling

mlr_pipeops_nn_avg_pool1d PipeOpTorchAvgPool1D

1D Average Pooling

mlr_pipeops_nn_avg_pool2d PipeOpTorchAvgPool2D

2D Average Pooling

mlr_pipeops_nn_avg_pool3d PipeOpTorchAvgPool3D

3D Average Pooling

mlr_pipeops_nn_batch_norm1d PipeOpTorchBatchNorm1D

1D Batch Normalization

mlr_pipeops_nn_batch_norm2d PipeOpTorchBatchNorm2D

2D Batch Normalization

mlr_pipeops_nn_batch_norm3d PipeOpTorchBatchNorm3D

3D Batch Normalization

mlr_pipeops_nn_block PipeOpTorchBlock

Block Repetition

mlr_pipeops_nn_celu PipeOpTorchCELU

CELU Activation Function

mlr_pipeops_nn_conv1d PipeOpTorchConv1D

1D Convolution

mlr_pipeops_nn_conv2d PipeOpTorchConv2D

2D Convolution

mlr_pipeops_nn_conv3d PipeOpTorchConv3D

3D Convolution

mlr_pipeops_nn_conv_transpose1d PipeOpTorchConvTranspose1D

Transpose 1D Convolution

mlr_pipeops_nn_conv_transpose2d PipeOpTorchConvTranspose2D

Transpose 2D Convolution

mlr_pipeops_nn_conv_transpose3d PipeOpTorchConvTranspose3D

Transpose 3D Convolution

mlr_pipeops_nn_dropout PipeOpTorchDropout

Dropout

mlr_pipeops_nn_elu PipeOpTorchELU

ELU Activation Function

mlr_pipeops_nn_flatten PipeOpTorchFlatten

Flattens a Tensor

mlr_pipeops_nn_fn PipeOpTorchFn

Custom Function

mlr_pipeops_nn_ft_cls PipeOpTorchFTCLS

CLS Token for FT-Transformer

mlr_pipeops_nn_ft_transformer_block PipeOpTorchFTTransformerBlock

Single Transformer Block for the FT-Transformer

mlr_pipeops_nn_geglu PipeOpTorchGeGLU

GeGLU Activation Function

mlr_pipeops_nn_gelu PipeOpTorchGELU

GELU Activation Function

mlr_pipeops_nn_glu PipeOpTorchGLU

GLU Activation Function

mlr_pipeops_nn_hardshrink PipeOpTorchHardShrink

Hard Shrink Activation Function

mlr_pipeops_nn_hardsigmoid PipeOpTorchHardSigmoid

Hard Sigmoid Activation Function

mlr_pipeops_nn_hardtanh PipeOpTorchHardTanh

Hard Tanh Activation Function

mlr_pipeops_nn_head PipeOpTorchHead

Output Head

mlr_pipeops_nn_identity PipeOpTorchIdentity

Identity Layer

mlr_pipeops_nn_layer_norm PipeOpTorchLayerNorm

Layer Normalization

mlr_pipeops_nn_leaky_relu PipeOpTorchLeakyReLU

Leaky ReLU Activation Function

mlr_pipeops_nn_linear PipeOpTorchLinear

Linear Layer

mlr_pipeops_nn_log_sigmoid PipeOpTorchLogSigmoid

Log Sigmoid Activation Function

mlr_pipeops_nn_max_pool1d PipeOpTorchMaxPool1D

1D Max Pooling

mlr_pipeops_nn_max_pool2d PipeOpTorchMaxPool2D

2D Max Pooling

mlr_pipeops_nn_max_pool3d PipeOpTorchMaxPool3D

3D Max Pooling

mlr_pipeops_nn_merge PipeOpTorchMerge

Merge Operation

mlr_pipeops_nn_merge_cat PipeOpTorchMergeCat

Merge by Concatenation

mlr_pipeops_nn_merge_prod PipeOpTorchMergeProd

Merge by Product

mlr_pipeops_nn_merge_sum PipeOpTorchMergeSum

Merge by Summation

mlr_pipeops_nn_prelu PipeOpTorchPReLU

PReLU Activation Function

mlr_pipeops_nn_reglu PipeOpTorchReGLU

ReGLU Activation Function

mlr_pipeops_nn_relu PipeOpTorchReLU

ReLU Activation Function

mlr_pipeops_nn_relu6 PipeOpTorchReLU6

ReLU6 Activation Function

mlr_pipeops_nn_reshape PipeOpTorchReshape

Reshape a Tensor

mlr_pipeops_nn_rrelu PipeOpTorchRReLU

RReLU Activation Function

mlr_pipeops_nn_selu PipeOpTorchSELU

SELU Activation Function

mlr_pipeops_nn_sigmoid PipeOpTorchSigmoid

Sigmoid Activation Function

mlr_pipeops_nn_softmax PipeOpTorchSoftmax

Softmax

mlr_pipeops_nn_softplus PipeOpTorchSoftPlus

SoftPlus Activation Function

mlr_pipeops_nn_softshrink PipeOpTorchSoftShrink

Soft Shrink Activation Function

mlr_pipeops_nn_softsign PipeOpTorchSoftSign

SoftSign Activation Function

mlr_pipeops_nn_squeeze PipeOpTorchSqueeze

Squeeze a Tensor

mlr_pipeops_nn_tanh PipeOpTorchTanh

Tanh Activation Function

mlr_pipeops_nn_tanhshrink PipeOpTorchTanhShrink

Tanh Shrink Activation Function

mlr_pipeops_nn_threshold PipeOpTorchThreshold

Treshold Activation Function

mlr_pipeops_nn_tokenizer_categ PipeOpTorchTokenizerCateg

Categorical Tokenizer

mlr_pipeops_nn_tokenizer_num PipeOpTorchTokenizerNum

Numeric Tokenizer

mlr_pipeops_nn_unsqueeze PipeOpTorchUnsqueeze

Unqueeze a Tensor

Preprocessing & Augmentation

mlr_pipeops_preproc_torch PipeOpTaskPreprocTorch

Base Class for Lazy Tensor Preprocessing

pipeop_preproc_torch()

Create Torch Preprocessing PipeOps

mlr_pipeops_trafo_nop PipeOpPreprocTorchTrafoNop

No Transformation

mlr_pipeops_trafo_reshape PipeOpPreprocTorchTrafoReshape

Reshaping Transformation

mlr_pipeops_augment_center_crop PipeOpPreprocTorchAugmentCenterCrop

Center Crop Augmentation

mlr_pipeops_augment_color_jitter PipeOpPreprocTorchAugmentColorJitter

Color Jitter Augmentation

mlr_pipeops_augment_crop PipeOpPreprocTorchAugmentCrop

Crop Augmentation

mlr_pipeops_augment_hflip PipeOpPreprocTorchAugmentHflip

Horizontal Flip Augmentation

mlr_pipeops_augment_random_affine PipeOpPreprocTorchAugmentRandomAffine

Random Affine Augmentation

mlr_pipeops_augment_random_choice PipeOpPreprocTorchAugmentRandomChoice

Random Choice Augmentation

mlr_pipeops_augment_random_crop PipeOpPreprocTorchAugmentRandomCrop

Random Crop Augmentation

mlr_pipeops_augment_random_horizontal_flip PipeOpPreprocTorchAugmentRandomHorizontalFlip

Random Horizontal Flip Augmentation

mlr_pipeops_augment_random_order PipeOpPreprocTorchAugmentRandomOrder

Random Order Augmentation

mlr_pipeops_augment_random_resized_crop PipeOpPreprocTorchAugmentRandomResizedCrop

Random Resized Crop Augmentation

mlr_pipeops_augment_random_vertical_flip PipeOpPreprocTorchAugmentRandomVerticalFlip

Random Vertical Flip Augmentation

mlr_pipeops_augment_resized_crop PipeOpPreprocTorchAugmentResizedCrop

Resized Crop Augmentation

mlr_pipeops_augment_rotate PipeOpPreprocTorchAugmentRotate

Rotate Augmentation

mlr_pipeops_augment_vflip PipeOpPreprocTorchAugmentVflip

Vertical Flip Augmentation

mlr_pipeops_trafo_adjust_brightness PipeOpPreprocTorchTrafoAdjustBrightness

Adjust Brightness Transformation

mlr_pipeops_trafo_adjust_gamma PipeOpPreprocTorchTrafoAdjustGamma

Adjust Gamma Transformation

mlr_pipeops_trafo_adjust_hue PipeOpPreprocTorchTrafoAdjustHue

Adjust Hue Transformation

mlr_pipeops_trafo_adjust_saturation PipeOpPreprocTorchTrafoAdjustSaturation

Adjust Saturation Transformation

mlr_pipeops_trafo_grayscale PipeOpPreprocTorchTrafoGrayscale

Grayscale Transformation

mlr_pipeops_trafo_normalize PipeOpPreprocTorchTrafoNormalize

Normalization Transformation

mlr_pipeops_trafo_pad PipeOpPreprocTorchTrafoPad

Padding Transformation

mlr_pipeops_trafo_resize PipeOpPreprocTorchTrafoResize

Resizing Transformation

mlr_pipeops_trafo_rgb_to_grayscale PipeOpPreprocTorchTrafoRgbToGrayscale

RGB to Grayscale Transformation

NN Modules

nn()

Create a Neural Network Layer

nn_ft_cls()

CLS Token for FT-Transformer

nn_ft_transformer_block()

Single Transformer Block for FT-Transformer

nn_geglu()

GeGLU Module

nn_graph()

Graph Network

nn_merge_cat()

Concatenates multiple tensors

nn_merge_prod()

Product of multiple tensors

nn_merge_sum()

Sum of multiple tensors

nn_reglu()

ReGLU Module

nn_reshape()

Reshape

nn_squeeze()

Squeeze

nn_tokenizer_categ()

Categorical Tokenizer

nn_tokenizer_num()

Numeric Tokenizer

nn_unsqueeze()

Unsqueeze

Lazy Tensor

lazy_tensor()

Create a lazy tensor

lazy_shape()

Shape of Lazy Tensor

DataDescriptor

Data Descriptor

as_lazy_tensor()

Convert to Lazy Tensor

as_data_descriptor()

Convert to Data Descriptor

assert_lazy_tensor()

Assert Lazy Tensor

is_lazy_tensor()

Check for lazy tensor

materialize()

Materialize Lazy Tensor Columns

Loss

t_loss() t_losses()

Loss Function Quick Access

TorchLoss

Torch Loss

mlr_pipeops_torch_loss PipeOpTorchLoss

Loss Configuration

as_torch_loss()

Convert to TorchLoss

mlr3torch_losses

Loss Functions

cross_entropy

Cross Entropy Loss

Optimizer

t_opt() t_opts()

Optimizers Quick Access

TorchLoss

Torch Loss

mlr_pipeops_torch_optimizer PipeOpTorchOptimizer

Optimizer Configuration

as_torch_optimizer()

Convert to TorchOptimizer

mlr3torch_optimizers

Optimizers

Callbacks

callback_set()

Create a Set of Callbacks for Torch

torch_callback()

Create a Callback Descriptor

t_clbk() t_clbks()

Sugar Function for Torch Callback

TorchCallback

Torch Callback

TorchDescriptor

Base Class for Torch Descriptors

TorchIngressToken()

Torch Ingress Token

TorchLoss

Torch Loss

TorchOptimizer

Torch Optimizer

mlr_callback_set CallbackSet

Base Class for Callbacks

mlr_callback_set.checkpoint CallbackSetCheckpoint

Checkpoint Callback

mlr_callback_set.history CallbackSetHistory

History Callback

mlr_callback_set.lr_scheduler CallbackSetLRScheduler

Learning Rate Scheduling Callback

mlr_callback_set.lr_scheduler_one_cycle CallbackSetLRSchedulerOneCycle

OneCycle Learning Rate Scheduling Callback

mlr_callback_set.lr_scheduler_reduce_on_plateau CallbackSetLRSchedulerReduceOnPlateau

Reduce On Plateau Learning Rate Scheduler

mlr_callback_set.progress CallbackSetProgress

Progress Callback

mlr_callback_set.tb CallbackSetTB

TensorBoard Logging Callback

mlr_callback_set.unfreeze CallbackSetUnfreeze

Unfreezing Weights Callback

as_torch_callback()

Convert to a TorchCallback

as_torch_callbacks()

Convert to a list of Torch Callbacks

mlr_pipeops_torch_callbacks PipeOpTorchCallbacks

Callback Configuration

mlr3torch_callbacks

Dictionary of Torch Callbacks

mlr_context_torch ContextTorch

Context for Torch Learner

as_lr_scheduler()

Convert to CallbackSetLRScheduler

Helper

TorchDescriptor

Base Class for Torch Descriptors

auto_device()

Auto Device

task_dataset()

Create a Dataset from a Task

select_all() select_none() select_grep() select_name() select_invert()

Selector Functions for Character Vectors

output_dim_for()

Network Output Dimension

infer_shapes()

Infer Shapes