GroupNorm¶

class nvtripy.GroupNorm(num_groups: int, num_channels: int, dtype: dtype = float32, eps: float = 1e-05)[source]¶

Bases: Module

Applies group normalization over the input tensor:

\(\text{GroupNorm}(x) = \Large \frac{x - \bar{x}}{ \sqrt{\sigma^2 + \epsilon}} \normalsize * \gamma + \beta\)

where \(\bar{x}\) is the mean and \(\sigma^2\) is the variance.

Parameters:

num_groups (int) – The number of groups to split the channels into.
num_channels (int) – The number of channels expected in the input.
dtype (dtype) – The data type to use for the weight and bias parameters.
eps (float) – \(\epsilon\) value to prevent division by zero.

Example

group_norm = tp.GroupNorm(2, 4)
group_norm.weight = tp.ones_like(group_norm.weight)
group_norm.bias = tp.zeros_like(group_norm.bias)

input = tp.iota((1, 4, 2, 2), dim=1)
output = group_norm(input)

Local Variables¶

>>> group_norm
GroupNorm(
    weight: Parameter = (shape=[4], dtype=float32),
    bias: Parameter = (shape=[4], dtype=float32),
)
>>> group_norm.state_dict()
{
    weight: tensor([1.0000, 1.0000, 1.0000, 1.0000], dtype=float32, loc=gpu:0, shape=(4,)),
    bias: tensor([0.0000, 0.0000, 0.0000, 0.0000], dtype=float32, loc=gpu:0, shape=(4,)),
}

>>> input
tensor(
    [[[[0.0000, 0.0000],
       [0.0000, 0.0000]],

      [[1.0000, 1.0000],
       [1.0000, 1.0000]],

      [[2.0000, 2.0000],
       [2.0000, 2.0000]],

      [[3.0000, 3.0000],
       [3.0000, 3.0000]]]], 
    dtype=float32, loc=gpu:0, shape=(1, 4, 2, 2))

>>> output
tensor(
    [[[[-1.0000, -1.0000],
       [-1.0000, -1.0000]],

      [[1.0000, 1.0000],
       [1.0000, 1.0000]],

      [[-1.0000, -1.0000],
       [-1.0000, -1.0000]],

      [[1.0000, 1.0000],
       [1.0000, 1.0000]]]], 
    dtype=float32, loc=gpu:0, shape=(1, 4, 2, 2))

load_state_dict(state_dict: Dict[str, Tensor], strict: bool = True) → Tuple[Set[str], Set[str]]¶

Loads parameters from the provided state_dict into the current module. This will recurse over any nested child modules.

Parameters:

state_dict (Dict[str, Tensor]) – A dictionary mapping names to parameters.
strict (bool) – If True, keys in state_dict must exactly match those in this module. If not, an error will be raised.

Returns:

missing_keys: keys that are expected by this module but not provided in state_dict.
unexpected_keys: keys that are not expected by this module but provided in state_dict.

Return type:

A tuple of two sets of strings representing

Example

# Using the `module` and `state_dict` from the `state_dict()` example:
print(f"Before: {module.param}")

state_dict["param"] = tp.zeros((2,), dtype=tp.float32)
module.load_state_dict(state_dict)

print(f"After: {module.param}")

Output¶

Before: tensor([1.0000, 1.0000], dtype=float32, loc=gpu:0, shape=(2,))
After: tensor([0.0000, 0.0000], dtype=float32, loc=gpu:0, shape=(2,))

See also

state_dict()

named_children() → Iterator[Tuple[str, Module]]¶

Returns an iterator over immediate children of this module, yielding tuples containing the name of the child module and the child module itself.

Returns:: An iterator over tuples containing the name of the child module and the child module itself.
Return type:: Iterator[Tuple[str, Module]]

Example

class StackedLinear(tp.Module):
    def __init__(self):
        super().__init__()
        self.linear1 = tp.Linear(2, 2)
        self.linear2 = tp.Linear(2, 2)


stacked_linear = StackedLinear()

for name, module in stacked_linear.named_children():
    print(f"{name}: {type(module).__name__}")

Output¶

linear1: Linear
linear2: Linear

named_parameters() → Iterator[Tuple[str, Tensor]]¶

Returns:: An iterator over tuples containing the name of a parameter and the parameter itself.
Return type:: Iterator[Tuple[str, Tensor]]

Example

class MyModule(tp.Module):
    def __init__(self):
        super().__init__()
        self.alpha = tp.Tensor(1)
        self.beta = tp.Tensor(2)


linear = MyModule()

for name, parameter in linear.named_parameters():
    print(f"{name}: {parameter}")

Output¶

alpha: tensor(1, dtype=int32, loc=gpu:0, shape=())
beta: tensor(2, dtype=int32, loc=gpu:0, shape=())

state_dict() → Dict[str, Tensor]¶

Returns a dictionary mapping names to parameters in the module. This will recurse over any nested child modules.

Returns:: A dictionary mapping names to parameters.
Return type:: Dict[str, Tensor]

Example

class MyModule(tp.Module):
    def __init__(self):
        super().__init__()
        self.param = tp.ones((2,), dtype=tp.float32)
        self.linear1 = tp.Linear(2, 2)
        self.linear2 = tp.Linear(2, 2)


module = MyModule()

state_dict = module.state_dict()

Local Variables¶

>>> state_dict
{
    param: tensor([1.0000, 1.0000], dtype=float32, loc=gpu:0, shape=(2,)),
    linear1.weight: tensor(
        [[0.0000, 1.0000],
         [2.0000, 3.0000]], 
        dtype=float32, loc=gpu:0, shape=(2, 2)),
    linear1.bias: tensor([0.0000, 1.0000], dtype=float32, loc=gpu:0, shape=(2,)),
    linear2.weight: tensor(
        [[0.0000, 1.0000],
         [2.0000, 3.0000]], 
        dtype=float32, loc=gpu:0, shape=(2, 2)),
    linear2.bias: tensor([0.0000, 1.0000], dtype=float32, loc=gpu:0, shape=(2,)),
}

num_groups: int¶: The number of groups to split the channels into.

num_channels: int¶: The number of channels expected in the input.

dtype: dtype¶: The data type used to perform the operation.

weight: Tensor¶: The \(\gamma\) parameter of shape \([\text{num_channels}]\).

bias: Tensor¶: The \(\beta\) parameter of shape \([\text{num_channels}]\).

eps: float¶: A value added to the denominator to prevent division by zero. Defaults to 1e-5.

__call__(x: Tensor) → Tensor[source]¶

Parameters:: x (Tensor) – The input tensor.
Returns:: A tensor of the same shape as the input.
Return type:: Tensor