Skip to content
heliaEDGE
Reference
HELIA

resnet

ResNet is a type of convolutional neural network (CNN) that is commonly used for image classification tasks. ResNet is a fully convolutional network that consists of a series of convolutional layers and pooling layers. The pooling layers are used to downsample the input while the convolutional layers are used to upsample the input. The skip connections between the pooling layers and convolutional layers allow ResNet to preserve spatial/temporal information while also allowing for faster training and inference times.

For more info, refer to the original paper Deep Residual Learning for Image Recognition.

Parameters are in helia_edge.models.resnet_params.

Functions

Name Description
build ResNet model from ResNetParams
generate_bottleneck_block Generate functional bottleneck block
generate_residual_block Generate functional residual block
resnet_layer Generate functional ResNet model
  • Enable 1D and 2D variants.

Machine-readable model

function

Generate functional bottleneck block.

helia_edge/models/resnet.py:31

generate_bottleneck_block(
filters: int,
kernel_size: int | tuple[int, int] = 3,
strides: int | tuple[int, int] = 1,
expansion: int = 4,
activation: str = 'relu6',
) -> keras.Layer

Generate functional bottleneck block.

Parameters of generate_bottleneck_block
NameTypeDefaultDescription
filtersintRequiredFilter size
kernel_sizeint | tuple[int, int]3Kernel size. Defaults to 3.
stridesint | tuple[int, int]1Stride length. Defaults to 1.
expansionint4Expansion factor. Defaults to 4.
Returns of generate_bottleneck_block
TypeDescription
keras.Layerkeras.Layer: TF functional layer
function

Generate functional residual block

helia_edge/models/resnet.py:75

generate_residual_block(
filters: int,
kernel_size: int | tuple[int, int] = 3,
strides: int | tuple[int, int] = 1,
activation: str = 'relu6',
) -> keras.Layer

Generate functional residual block

Parameters of generate_residual_block
NameTypeDefaultDescription
filtersintRequiredFilter size
kernel_sizeint | tuple[int, int]3Kernel size. Defaults to 3.
stridesint | tuple[int, int]1Stride length. Defaults to 1.
Returns of generate_residual_block
TypeDescription
keras.Layerkeras.Layer: TF functional layer
function

Generate functional ResNet model.

helia_edge/models/resnet.py:111

resnet_layer(x: keras.KerasTensor, params: ResNetParams) -> keras.KerasTensor

Generate functional ResNet model. Args: x (keras.KerasTensor): Inputs params (ResNetParams): Model parameters.

Returns of resnet_layer
TypeDescription
keras.KerasTensorkeras.KerasTensor: Output tensor
function

build

Python

Build a ResNet model.

helia_edge/models/resnet.py:169

build(
params: ResNetParams,
input_shape: tuple[int | None, ...],
*,
batch_size: int | None = None,
name: str | None = None,
) -> keras.Model

Build a ResNet model.

Parameters of build
NameTypeDefaultDescription
paramsResNetParamsRequiredModel parameters.
input_shapetuple[int | None, ...]RequiredInput shape without the batch axis; None for a variable axis.
batch_sizeint | NoneNoneStatic batch size; None for a dynamic batch.
namestr | NoneNoneModel name; the family when None.
Returns of build
TypeDescription
keras.Modelkeras.Model: The model, named ``resnet`` unless ``name`` is given.