NumpyDirichletDistribution

class probly.representation.distribution.numpy_dirichlet.NumpyDirichletDistribution(alphas: ndarray)[source]

Bases: NumpyAxisProtected[NumpyDirichletDistribution, NumpyDirichletDistribution | np.ndarray | float, NumpyDirichletDistribution, Never, NumpyDirichletDistribution, NDArray[bool], NumpyDirichletDistribution], DirichletDistribution[NumpyCategoricalDistribution]

A Dirichlet distribution stored as a numpy array.

Shape: (…, num_classes) The last axis represents the category dimension.

property T: ShapeResultT

The transposed version of the underlying array.

alphas: np.ndarray
astype(dtype: DTypeLike, order: Order = 'K', casting: Literal['no', 'equiv', 'safe', 'same_kind', 'unsafe'] = 'unsafe', subok: bool = True, copy: bool = True) → OpResultT[source]

Cast each protected field using ndarray.astype’s casting and layout options.

copy(order: Order = 'C') → OwnerT[source]

Return a copy of the array.

property device: str

Device of the array.

property dtype: dtype

Data type of the array.

entropy() → ArrayLike[source]

Compute entropy.

property flags: ArrayFlagsLike

The flags of the array.

classmethod from_array(alphas: np.ndarray | list, dtype: DTypeLike | None = None) → Self[source]

Create a Dirichlet distribution from an array or list.

property mT: ShapeResultT

The transposed version of the underlying array.

property mean: NumpyCategoricalDistribution

Return the mean of the Dirichlet distribution.

property ndim: int

Number of dimensions.

permitted_functions: ClassVar[set[Callable]] = {<function average>, <function mean>, <function sum>}
permitted_ufuncs: ClassVar[dict[np.ufunc, list[str]]] = {<ufunc 'add'>: ['__call__'], <ufunc 'equal'>: ['__call__'], <ufunc 'not_equal'>: ['__call__'], <ufunc 'subtract'>: ['__call__']}
primary_protected_name = 'alphas'
protected_axes = {'alphas': 1}
property protected_shape: tuple[int, ...]

Protected trailing shape of the primary field.

protected_value() → NumpyProtectedValue[source]

Return the primary protected value.

protected_values(func: Callable | None = None, method: str | None = None) → dict[str, NumpyProtectedValue] | None[source]

Read effective values, with optional NumPy function or ufunc permissions.

reshape(*shape: int | tuple[int, ...], order: str = 'C', copy: bool | None = None) → ShapeResultT[source]

Return a copy with reshaped protected values.

sample(num_samples: int = 1, rng: Generator | None = None) → NumpySample[NumpyCategoricalDistribution][source]

Sample from the Dirichlet distribution (NumPy backend).

property shape: tuple[int, ...]

Read the logical shape without collecting fields unless all broadcast.

property size: int

Number of elements in the array.

to_device(device: Any, /, *, stream: Any = None) → Self[source]

Move the array to a device.

transpose(*axes: int | Sequence[int] | None) → ShapeResultT[source]

Return a transposed version of the NumpySample.

This method implicitly also provides full axis tracking support for - np.moveaxis - np.rollaxis Those functions call out to transpose methods for custom array types.

Parameters:

axes – The axes to transpose.

Returns:

A transposed version of the NumpySample.

type = 'dirichlet'
validate() → None[source]

Raise if effective fields have insufficient rank or incompatible batches.

Call explicitly, or from __post_init__ to check dataclass construction. Fields owned by initialization (init=False) are excluded.

with_protected_values(values: dict[str, NumpyProtectedValue], func: Callable | None = None) → OwnerT | OpResultT | ShapeResultT | CompResultT | SetResultT[source]

Return a copy with updated protected field values.

Examples using probly.representation.distribution.numpy_dirichlet.NumpyDirichletDistribution

Second order: a parameterized Dirichlet

Second order: a parameterized Dirichlet