JaxConvexCredalSet¶
- class probly.representation.credal_set.jax.JaxConvexCredalSet(tensor: JaxCategoricalDistribution)[source]¶
Bases:
JaxAxisProtected[JaxConvexCredalSet,JaxConvexCredalSet,JaxConvexCredalSet,Never,JaxConvexCredalSet,Array,JaxConvexCredalSet],JaxCategoricalCredalSet,ConvexCredalSetA convex hull over a finite set of categorical distributions.
- property T: ShapeResultT¶
Inverts the order of the axes of the underlying array.
- astype(dtype: DTypeLike | None, copy: bool = False, device: jax.Device | Sharding | None = None) Self[source]¶
Return a copy of the array cast to the given data type.
- Parameters:
dtype – The target data type.
copy – Whether to always return a copy.
device – The device the result should live on.
- Returns:
A copy with every array-valued field cast to the given data type.
- property at: JaxAxisProtectedIndexUpdateHelper[Self | SetValueT, SetResultT, ShapeResultT]¶
Return an indexed helper whose updates require
permitted_at_methodspermission.
- property barycenter: JaxCategoricalDistribution¶
Compute the barycenter of the convex credal set as the mean of the vertices.
- block_until_ready() Self[source]¶
Block until the asynchronous computation of every array-valued field has finished.
- Returns:
The object itself.
- broadcasted_batch = {}¶
- property device: Device¶
Device of the array.
- flatten(order: str = 'C') ShapeResultT[source]¶
Return a flattened version of the array.
- Parameters:
order – The read/write element order.
- Returns:
The flattened array.
- classmethod from_jax_sample(sample: JaxSample[JaxCategoricalDistribution]) Self[source]¶
Create a credal set from categorical distribution samples.
- classmethod from_sample(sample: Sample[JaxCategoricalDistribution]) Self[source]¶
Create a credal set from a finite sample.
- Parameters:
sample – The sample to create the credal set from.
- Returns:
The created credal set.
- item(*args: int) bool | int | float | complex[source]¶
Return the array as a Python scalar.
- Parameters:
*args – Optional index of the element to return.
- Returns:
The selected element as a Python scalar.
- property mH: ShapeResultT¶
The adjoint (conjugate) transposed version of the underlying array.
- property mT: ShapeResultT¶
The version of the underlying array with its last two axes swapped.
- permitted_at_methods = {'set'}¶
- permitted_functions = {}¶
- primary_protected_name = 'tensor'¶
- protected_values(func: Callable | None = None) dict[str, V] | None[source]¶
Read effective values as-is, optionally checking function permissions.
- pytree_children = ('tensor',)¶
- ravel(order: str = 'C') ShapeResultT[source]¶
Return a flattened version of the array.
- Parameters:
order – The read/write element order.
- Returns:
The flattened array.
- reshape(*args: int | Sequence[int], order: str = 'C') ShapeResultT[source]¶
Return a copy with reshaped protected values.
- property shape: tuple[int, ...]¶
Read the logical shape without collecting fields unless all broadcast.
- squeeze(axis: int | Sequence[int] | None = None) ShapeResultT[source]¶
Return the array with axes of length one removed.
- Parameters:
axis – The axis or axes to remove. If omitted, all length-one axes are removed.
- Returns:
The squeezed array.
- stop_gradient() Self[source]¶
Return a copy detached from the autodiff graph.
Subclasses holding NumPy sidecar fields should override this to leave those fields untouched.
- Returns:
A copy through which gradients do not propagate.
- take_along_axis(indices: jax.Array, axis: int = -1) ShapeResultT[source]¶
Return a copy with gathered protected values along a batch dimension.
- tensor: JaxCategoricalDistribution¶
- to_device(device: Any, /, *, stream: int | Any | None = None) Self[source]¶
Move the array to the given device.
- Parameters:
device – The target device.
stream – Unsupported by JAX, must be None.
- Returns:
A copy with every array-valued field on the given device.
- Raises:
NotImplementedError – If
streamis not None.
- transpose(*args: int | Sequence[int] | None) ShapeResultT[source]¶
Return a transposed version of the array.
- Parameters:
*args – The permutation of the axes, either as a single sequence or as separate integers. If omitted, the axes are reversed.
- Returns:
The transposed array.
- tree_flatten() tuple[tuple[Any, ...], Any][source]¶
Split the object into pytree children and static auxiliary data.
Only fields declared in
pytree_childrenbecome children, regardless of their values. All other fields become static auxiliary data. Subclasses may override this together withtree_unflatten()to provide different transformation semantics. NumPy array children are rejected by default, including for native tree utilities; opaque eager mapping does not flatten.- Returns:
The children and the auxiliary data.
- Raises:
TypeError – If the schema, dynamic fields, or static metadata is unsupported.
ValueError – If child field names are repeated or unknown.
- tree_map_traverse = False¶
- classmethod tree_unflatten(aux_data: Any, children: tuple[Any, ...]) Self[source]¶
Rebuild an object from pytree children and auxiliary data.
Neither
__init__nor__post_init__is called: JAX may provide tracers, placeholders, or cotangents that violate primal-value invariants.- Parameters:
aux_data – The auxiliary data produced by
tree_flatten().children – The children produced by
tree_flatten().
- Returns:
The reconstructed object.
- type = 'categorical'¶
- 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.
- view(dtype: DTypeLike | None = None, type: None = None) Self[source]¶
Return a bit-cast view of the array.
- Parameters:
dtype – The data type to reinterpret the underlying bytes as.
type – Unsupported by JAX, must be
None.
- Returns:
A copy with every array-valued field bit-cast to the given data type.
- Raises:
NotImplementedError – If
typeis not None.