TorchMixtureDistribution

class probly.representation.distribution.torch_mixture.TorchMixtureDistribution(components: D = <property object>, mixture_weights: torch.Tensor = <property object>, type: Literal['mixture'] = 'mixture')

Bases: TorchAxisProtected, MixtureDistribution, Generic

Mixture distribution with torch tensor mixture weights.

The final batch axis of components and mixture_weights is the protected component axis. The exposed shape is the shared batch shape before that component axis.

property T: Self

Inverts the order of the dimensions of the underlying array.

clone(*, memory_format: memory_format = torch.preserve_format) → Self

Return a copy of the array.

component_type

alias of Distribution

components: D

cpu(memory_format: memory_format = torch.preserve_format) → Self

Move the array to the CPU.

cuda(device: device | str | None = None, non_blocking: bool = False, memory_format: memory_format = torch.preserve_format) → Self

Move the array to the GPU.

detach() → Self

Return a detached version of the array.

property device: device

Device of the array.

property dtype: dtype

Data type of the array.

entropy() → ArrayLike

Compute entropy.

gather(dim: int, index: Tensor) → Self

Return a copy with gathered protected values along a batch dimension.

property mH: Self

The adjoint (conjugate) transposed version of the underlying array.

property mT: Self

The transposed version of the underlying array.

property mean: T

Compute the mean of the mixture distribution.

mixture_weights: torch.Tensor

property ndim: int

Number of dimensions.

property normalized_mixture_weights: Tensor

Return mixture weights normalized along the component axis.

numpy(*, force: bool = False) → ndarray

Convert to a numpy array.

permitted_functions = {}

permute(*dims: Size | int | tuple[int] | list[int]) → Self

Return a permuted version of the array.

classmethod primary_protected_name() → str

Return the first protected field (dict order).

protected_axes: ClassVar[dict[str, int]] = {'components': 1, 'mixture_weights': 1}

property protected_shape: tuple[int, ...]

Protected trailing shape of the primary field.

protected_value() → TorchProtectedValue

Return the primary protected value.

protected_values(func: Callable | None = None) → dict[str, TorchProtectedValue] | None

Return all protected field values as-is.

Optionally takes the torch function that triggered the call for context. This can be used to conditionally modify the returned values or prevent them from being accessed.

reshape(*shape: int | tuple[int, ...]) → Self

Return a copy with reshaped protected values.

resolve_conj() → Self

Return a version of the array with any conjugate operations resolved.

resolve_neg() → Self

Return a version of the array with any negation operations resolved.

sample(num_samples: int = 1, rng: torch.Generator | None = None) → TorchSample[T]

Draw samples from the mixture distribution.

Parameters:

• num_samples – Number of samples to draw.

• rng – Optional torch random generator used for component selection and forwarded to components that accept an rng argument.

Returns:

Samples drawn from the selected mixture components.

property shape: tuple[int, ...]

Shape of the array.

size(dim: int | None = None) → int | Size

Return the size of the array along the given dimension.

to(*args: Any, **kwargs: Any) → Self

Move and/or cast the tensor, mirroring torch.Tensor.to.

to_device(device: Literal['cpu'], /, *, stream: int | Any | None = None) → Self

Move the array to a device.

transpose(dim0: int, dim1: int) → Self

Return a transposed version of the array.

type: Literal['mixture']

with_protected_values(values: dict[str, TorchProtectedValue], func: Callable | None = None) → TorchAxisProtected[T]

Return a copy with updated protected field values.