SetIoU

class hybrid_learning.concepts.train_eval.kpis.aggregating_kpis.SetIoU(output_thresh=0.5, label_thresh=0.0, smooth=1e-06)[source]

Bases: AggregatingKpi

Calc set intersection over union (IoU) value for a batch of outputs. The set intersection over union is a special reduction of the intersection over union for batch tensors. Given a dataset \(B\) it calculates as

\[\frac{\sum_B intersection} {\sum_B union} = \frac{\sum_B TP} {\sum_B TP + FP + FN}\]

with

  • FP / TP: false / true positives, i.e. in- / correctly predicted foreground pixels

  • FN / TN: false / true positives, i.e. in- / correctly predicted background pixels

The following tensor dimensions are allowed:

  • 1D: The tensor is assumed to be 1D without batch dimension.

  • 2D: The tensor is assumed to be 2D without batch dimension.

  • >2D: The tensor is assumed to be 2D with batch dimension 0, width dim. -1, height dim. -2.

Public Data Attributes:

Inherited from : py: class:Module

dump_patches

This allows better BC support for load_state_dict().

T_destination

alias of TypeVar('T_destination', bound=Mapping[str, Tensor])

Public Methods:

reset()

Called once at the beginning of a new epoch.

smooth_division(dividend, divisor)

Smoothed division using smoothening summand to avoid division by 0.

update(outputs, labels)

Smooth set intersection over union between binarized in- and output.

value()

Shall return the aggregated metric value as a scalar.
Inherited from : py: class:AggregatingKpi

update(outputs, labels)

Smooth set intersection over union between binarized in- and output.

reset()

Called once at the beginning of a new epoch.

value()

Shall return the aggregated metric value as a scalar.

value_and_reset()

Shorthand for subsequent calls to value and to reset.

forward(outputs, labels)

Calculate KPI without gradient.
Inherited from : py: class:Module

forward(outputs, labels)

Calculate KPI without gradient.

register_buffer(name, tensor[, persistent])

Adds a buffer to the module.

register_parameter(name, param)

Adds a parameter to the module.

add_module(name, module)

Adds a child module to the current module.

get_submodule(target)

Returns the submodule given by target if it exists, otherwise throws an error.

get_parameter(target)

Returns the parameter given by target if it exists, otherwise throws an error.

get_buffer(target)

Returns the buffer given by target if it exists, otherwise throws an error.

apply(fn)

Applies fn recursively to every submodule (as returned by .children()) as well as self.

cuda([device])

Moves all model parameters and buffers to the GPU.

xpu([device])

Moves all model parameters and buffers to the XPU.

cpu()

Moves all model parameters and buffers to the CPU.

type(dst_type)

Casts all parameters and buffers to dst_type.

float()

Casts all floating point parameters and buffers to float datatype.

double()

Casts all floating point parameters and buffers to double datatype.

half()

Casts all floating point parameters and buffers to half datatype.

bfloat16()

Casts all floating point parameters and buffers to bfloat16 datatype.

to_empty(*, device)

Moves the parameters and buffers to the specified device without copying storage.

to(*args, **kwargs)

Moves and/or casts the parameters and buffers.

register_backward_hook(hook)

Registers a backward hook on the module.

register_full_backward_hook(hook)

Registers a backward hook on the module.

register_forward_pre_hook(hook)

Registers a forward pre-hook on the module.

register_forward_hook(hook)

Registers a forward hook on the module.

state_dict([destination, prefix, keep_vars])

Returns a dictionary containing a whole state of the module.

load_state_dict(state_dict[, strict])

Copies parameters and buffers from state_dict into this module and its descendants.

parameters([recurse])

Returns an iterator over module parameters.

named_parameters([prefix, recurse])

Returns an iterator over module parameters, yielding both the name of the parameter as well as the parameter itself.

buffers([recurse])

Returns an iterator over module buffers.

named_buffers([prefix, recurse])

Returns an iterator over module buffers, yielding both the name of the buffer as well as the buffer itself.

children()

Returns an iterator over immediate children modules.

named_children()

Returns an iterator over immediate children modules, yielding both the name of the module as well as the module itself.

modules()

Returns an iterator over all modules in the network.

named_modules([memo, prefix, remove_duplicate])

Returns an iterator over all modules in the network, yielding both the name of the module as well as the module itself.

train([mode])

Sets the module in training mode.

eval()

Sets the module in evaluation mode.

requires_grad_([requires_grad])

Change if autograd should record operations on parameters in this module.

zero_grad([set_to_none])

Sets gradients of all model parameters to zero.

share_memory()

See torch.Tensor.share_memory_()

extra_repr()

Set the extra representation of the module

Special Methods:

__init__([output_thresh, label_thresh, smooth])

Init.
Inherited from : py: class:AggregatingKpi

__init__([output_thresh, label_thresh, smooth])

Init.
Inherited from : py: class:Module

__init__([output_thresh, label_thresh, smooth])

Init.

__call__(*input, **kwargs)

Call self as a function.

__setstate__(state)

__getattr__(name)

__setattr__(name, value)

Implement setattr(self, name, value).

__delattr__(name)

Implement delattr(self, name).

__repr__()

Return repr(self).

__dir__()

Default dir() implementation.
Parameters
__init__(output_thresh=0.5, label_thresh=0.0, smooth=1e-06)[source]

Init.

Parameters

  • output_thresh (float) – threshold for binarizing the output

  • label_thresh (float) – threshold for binarizing the labels

  • smooth (float) – summand to smooth the IoU value (evade division by 0)

reset()[source]

Called once at the beginning of a new epoch. Shall reset the aggregating statistics.

smooth_division(dividend, divisor)[source]

Smoothed division using smoothening summand to avoid division by 0.

Returns

result of smooth division.

update(outputs, labels)[source]

Smooth set intersection over union between binarized in- and output.

Parameters

  • outputs (Tensor) – Output tensors of shape (BATCH x 1 x H x W)

  • labels (Tensor) – Label tensors of shape (BATCH x H x W)

value()[source]

Shall return the aggregated metric value as a scalar.

Returns

tensor containing the given metric value.

Return type

Tensor

training: bool