NumpyDistanceBasedCredalSet

class probly.representation.credal_set.numpy.NumpyDistanceBasedCredalSet(nominal: NumpyCategoricalDistribution, radius: ndarray)[source]

Bases: NumpyAxisProtected[NumpyDistanceBasedCredalSet, NumpyDistanceBasedCredalSet, NumpyDistanceBasedCredalSet, Never, NumpyDistanceBasedCredalSet, NDArray[bool], NumpyDistanceBasedCredalSet], NumpyCategoricalCredalSet, DistanceBasedCredalSet

Distance-based credal set around a nominal categorical distribution.

property T: ShapeResultT

The transposed version of the underlying array.

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.

property barycenter: NumpyCategoricalDistribution

Return the nominal distribution as the barycenter of the credal set.

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.

property flags: ArrayFlagsLike

The flags of the array.

classmethod from_numpy_sample(sample: NumpySample[NumpyCategoricalDistribution]) → Self[source]

Create a credal set from categorical distribution samples.

classmethod from_sample(sample: Sample[NumpyCategoricalDistribution]) → Self[source]

Create a credal set from a sample of categorical distributions.

lower() → ndarray[source]

Compute the lower envelope of the credal set.

For L1/TV distance, the tightest element-wise lower bound is max(0, nominal - radius).

property mT: ShapeResultT

The transposed version of the underlying array.

property ndim: int

Number of dimensions.

nominal: NumpyCategoricalDistribution
property num_classes: int

Return the number of classes in the credal set.

permitted_functions = {}
permitted_ufuncs = {}
primary_protected_name = 'nominal'
protected_axes = {'nominal': 0, 'radius': 0}
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.

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

Return a copy with reshaped protected values.

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 = 'categorical'
upper() → ndarray[source]

Compute the upper envelope of the credal set.

For L1/TV distance, the tightest element-wise upper bound is min(1, nominal + radius).

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.credal_set.numpy.NumpyDistanceBasedCredalSet

Plotting binary credal sets on an interval

Plotting binary credal sets on an interval

Plotting credal sets on the simplex

Plotting credal sets on the simplex

Plotting credal sets on a spider (radar) chart

Plotting credal sets on a spider (radar) chart

Distance-based credal set

Distance-based credal set