mighty.utils.var_online.MeanOnline

class mighty.utils.var_online.MeanOnline(tensor=None)

Online sample mean aggregate. Works with scalars, vectors, and n-dimensional tensors.

Parameters:

tensortorch.Tensor or None

The initial tensor, if provided.

Methods

__init__([tensor])
activate(is_active)	Activates or deactivates the updates.
get_mean()
reset()	Reset the mean and the count.
update(tensor)	Update sample mean (and variance) from a batch of new values.

activate(is_active)

Activates or deactivates the updates.

Parameters:

is_activebool

New state.

get_mean()

Returns:

torch.Tensor

The mean of all tensors.

reset()

Reset the mean and the count.

update(tensor)

Update sample mean (and variance) from a batch of new values.

Parameters:

tensortorch.Tensor

Next tensor sample.