Skip to content

DropoutLayer

Bases: Layer

A dropout layer.

Parameters:

Name Type Description Default
probability float

The probability that an input element gets zeroed out.

 required

Raises:

Type Description
OutOfBoundsError

If probability is not in the range [0, 1].

Attributes:

Name Type Description
input_size int | ModelImageSize

Get the input_size of this layer.
output_size int | ModelImageSize

Get the output_size of this layer.
probability float

The probability that an input element gets zeroed out.
Source code in src/safeds/ml/nn/layers/_dropout_layer.py 
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
class DropoutLayer(Layer):
    """
    A dropout layer.

    Parameters
    ----------
    probability:
        The probability that an input element gets zeroed out.

    Raises
    ------
    OutOfBoundsError
        If probability is not in the range [0, 1].
    """

    def __init__(self, probability: float):
        _check_bounds("probability", probability, lower_bound=_ClosedBound(0), upper_bound=_ClosedBound(1))
        self._probability = probability
        self._input_size: int | ModelImageSize | None = None

    @property
    def probability(self) -> float:
        """The probability that an input element gets zeroed out."""
        return self._probability

    def _get_internal_layer(self, **_kwargs: Any) -> nn.Module:
        from ._internal_layers import _InternalDropoutLayer  # slow import on global level

        if self._input_size is None:
            raise ValueError(
                "The input_size is not yet set. The internal layer can only be created when the input_size is set.",
            )
        return _InternalDropoutLayer(self.probability)

    @property
    def input_size(self) -> int | ModelImageSize:
        """
        Get the input_size of this layer.

        Returns
        -------
        result:
            The amount of values being passed into this layer.

        Raises
        ------
        ValueError
            If the input_size is not yet set
        """
        if self._input_size is None:
            raise ValueError("The input_size is not yet set.")
        return self._input_size

    @property
    def output_size(self) -> int | ModelImageSize:
        """
        Get the output_size of this layer.

        Returns
        -------
        result:
            The amount of values being passed out of this layer.

        Raises
        ------
        ValueError
            If the input_size is not yet set
        """
        if self._input_size is None:
            raise ValueError("The input_size is not yet set.")
        return self._input_size

    def _set_input_size(self, input_size: int | ModelImageSize) -> None:
        self._input_size = input_size

    def _contains_choices(self) -> bool:
        return False

    def _get_layers_for_all_choices(self) -> list[DropoutLayer]:
        raise NotImplementedError  # pragma: no cover

    def __hash__(self) -> int:
        return _structural_hash(self._input_size, self._probability)

    def __eq__(self, other: object) -> bool:
        if not isinstance(other, DropoutLayer):
            return NotImplemented
        if self is other:
            return True
        return self._input_size == other._input_size and self._probability == other._probability

    def __sizeof__(self) -> int:
        if self._input_size is None:
            raise ValueError("The input_size is not yet set.")
        if isinstance(self._input_size, int):
            return int(self._input_size)
        elif isinstance(self._input_size, ModelImageSize):
            return self._input_size.__sizeof__()

input_size

Get the input_size of this layer.

Returns:

Name Type Description
result int | ModelImageSize

The amount of values being passed into this layer.

Raises:

Type Description
ValueError

If the input_size is not yet set

output_size

Get the output_size of this layer.

Returns:

Name Type Description
result int | ModelImageSize

The amount of values being passed out of this layer.

Raises:

Type Description
ValueError

If the input_size is not yet set

probability

The probability that an input element gets zeroed out.