minerva.models.nets.cnn_pf

Classes

CNN_PFF_2D

Simple pipeline for supervised models.

CNN_PF_2D

Simple pipeline for supervised models.

CNN_PF_Backbone

ZeroPadder2D

Module Contents

class minerva.models.nets.cnn_pf.CNN_PFF_2D(*args, **kwargs)

Bases: CNN_PF_2D

Simple pipeline for supervised models.

This class implements a very common deep learning pipeline, which is composed by the following steps:

  1. Make a forward pass with the input data on the backbone model;

  2. Make a forward pass with the input data on the fc model;

  3. Compute the loss between the output and the label data;

  4. Optimize the model (backbone and FC) parameters with respect to the loss.

This reduces the code duplication for autoencoder models, and makes it easier to implement new models by only changing the backbone model. More complex models, that does not follow this pipeline, should not inherit from this class. Note that, for this class the input data is a tuple of tensors, where the first tensor is the input data and the second tensor is the mask or label.

Initialize the model with the backbone, fc, loss function and metrics. Metrics are used to evaluate the model during training, validation, testing or prediction. It will be logged using lightning logger at the end of each epoch. Metrics should implement the torchmetrics.Metric interface.

Parameters

backbonetorch.nn.Module

The backbone model. Usually the encoder/decoder part of the model.

fctorch.nn.Module

The fully connected model, usually used to classification tasks. Use torch.nn.Identity() if no FC model is needed.

loss_fntorch.nn.Module

The function used to compute the loss.

learning_ratefloat, optional

The learning rate to Adam optimizer, by default 1e-3

flattenbool, optional

If True the input data will be flattened before passing through the fc model, by default True

train_metricsDict[str, Metric], optional

The metrics to be used during training, by default None

val_metricsDict[str, Metric], optional

The metrics to be used during validation, by default None

test_metricsDict[str, Metric], optional

The metrics to be used during testing, by default None

predict_metricsDict[str, Metric], optional

The metrics to be used during prediction, by default None

class minerva.models.nets.cnn_pf.CNN_PF_2D(pad_at, input_shape=(1, 6, 60), out_channels=16, num_classes=6, learning_rate=0.001, include_middle=False)

Bases: minerva.models.nets.base.SimpleSupervisedModel

Simple pipeline for supervised models.

This class implements a very common deep learning pipeline, which is composed by the following steps:

  1. Make a forward pass with the input data on the backbone model;

  2. Make a forward pass with the input data on the fc model;

  3. Compute the loss between the output and the label data;

  4. Optimize the model (backbone and FC) parameters with respect to the loss.

This reduces the code duplication for autoencoder models, and makes it easier to implement new models by only changing the backbone model. More complex models, that does not follow this pipeline, should not inherit from this class. Note that, for this class the input data is a tuple of tensors, where the first tensor is the input data and the second tensor is the mask or label.

Initialize the model with the backbone, fc, loss function and metrics. Metrics are used to evaluate the model during training, validation, testing or prediction. It will be logged using lightning logger at the end of each epoch. Metrics should implement the torchmetrics.Metric interface.

Parameters

backbonetorch.nn.Module

The backbone model. Usually the encoder/decoder part of the model.

fctorch.nn.Module

The fully connected model, usually used to classification tasks. Use torch.nn.Identity() if no FC model is needed.

loss_fntorch.nn.Module

The function used to compute the loss.

learning_ratefloat, optional

The learning rate to Adam optimizer, by default 1e-3

flattenbool, optional

If True the input data will be flattened before passing through the fc model, by default True

train_metricsDict[str, Metric], optional

The metrics to be used during training, by default None

val_metricsDict[str, Metric], optional

The metrics to be used during validation, by default None

test_metricsDict[str, Metric], optional

The metrics to be used during testing, by default None

predict_metricsDict[str, Metric], optional

The metrics to be used during prediction, by default None

_calculate_fc_input_features(backbone, input_shape)

Run a single forward pass with a random input to get the number of features after the convolutional layers.

Parameters

backbonetorch.nn.Module

The backbone of the network

input_shapeTuple[int, int, int]

The input shape of the network.

Returns

int

The number of features after the convolutional layers.

Parameters:

  • backbone (torch.nn.Module)

  • input_shape (Tuple[int, int, int])

Return type:

int

_create_fc(input_features, num_classes)
Parameters:

  • input_features (int)

  • num_classes (int)

Return type:

torch.nn.Module

Parameters:

  • pad_at (int)

  • input_shape (Tuple[int, int, int])

  • out_channels (int)

  • num_classes (int)

  • learning_rate (float)

  • include_middle (bool)

class minerva.models.nets.cnn_pf.CNN_PF_Backbone(pad_at, input_shape, out_channels=16, include_middle=False)

Bases: torch.nn.Module

Parameters:

  • pad_at (int)

  • input_shape (Tuple[int, int, int])

  • out_channels (int)

  • include_middle (bool)

forward(x)
class minerva.models.nets.cnn_pf.ZeroPadder2D(pad_at, padding_size)

Bases: torch.nn.Module

Parameters:

  • pad_at (List[int])

  • padding_size (int)

__repr__()
Return type:

str

__str__()
Return type:

str

forward(x)