unienv_interface.space.spaces.batched¶
Implementation of a space consisting of finitely many elements.
Classes:
| Name | Description |
|---|---|
BatchedSpace |
This space represents a batch of |
BatchedSpace
¶
BatchedSpace(
single_space: Space[SpaceDataT, BDeviceType, BDtypeType, BRNGType],
batch_shape: Sequence[int],
metadata: Optional[Mapping[str, Any]] = None,
)
Bases: Space[ndarray, BDeviceType, BDtypeType, BRNGType]
This space represents a batch of
Methods:
| Name | Description |
|---|---|
to |
|
sample |
|
create_empty |
|
is_bounded |
|
contains |
|
clip |
Clip every element of the object array |
get_repr |
|
is_subspaceeq |
Return whether this batched space is a subspace of |
data_to |
|
with_metadata |
Return a copy of this space with updated metadata (this space is left unchanged). |
is_subspace |
Return whether this space is a STRICT subspace of |
abbr_device |
Return the shared device across spaces, or |
Attributes:
| Name | Type | Description |
|---|---|---|
batch_shape |
|
|
single_space |
|
|
device |
Optional[_SpaceBDeviceT]
|
|
metadata |
SpaceMetadata
|
Read-only description of the data (see "Metadata" in the class docstring); empty if none was given. |
shape |
tuple[int, ...] | None
|
Return the shape of the space as an immutable property. |
metadata
property
¶
metadata: SpaceMetadata
Read-only description of the data (see "Metadata" in the class docstring); empty if none was given.
shape
property
¶
Return the shape of the space as an immutable property.
clip
¶
Clip every element of the object array x with single_space (see Space.clip).
Returns a new object array of batch_shape. Raises ValueError if
x is not an object array of batch_shape, or if any element
cannot be clipped.
get_repr
¶
is_subspaceeq
¶
Return whether this batched space is a subspace of other.
True iff other is a BatchedSpace on the same backend with equal
batch_shape and self.single_space.is_subspaceeq(other.single_space)
holds recursively (non-strict ⊆). device is ignored.
with_metadata
¶
with_metadata(
metadata: Optional[Mapping[str, Any]] = None,
/,
*,
replace: bool = False,
**updates: Any,
) -> Space[SpaceDataT, _SpaceBDeviceT, _SpaceBDTypeT, _SpaceBDRNGT]
Return a copy of this space with updated metadata (this space is left unchanged).
metadata and updates are merged into the current metadata, or
replace it entirely with replace=True (space.with_metadata(replace=True)
clears it). Nested spaces are shared with this space, not copied.
is_subspace
¶
is_subspace(other: Space) -> bool
Return whether this space is a STRICT subspace of other (self ⊂ other).
Defined uniformly for all spaces as::
self.is_subspace(other) ⟺ self.is_subspaceeq(other) and not other.is_subspaceeq(self)
I.e. self ⊆ other holds but other ⊆ self does not, so self
is a PROPER (strict) subspace of other. This is the ⊂ relation
versus the non-strict ⊆ provided by :meth:is_subspaceeq.
This definition is used instead of relying on __eq__ because some
space classes only have identity __eq__; defining strict
containment via the symmetric non-strict check works uniformly for all
classes regardless of their __eq__ implementation.
For structurally-distinct-but-mutually-containing spaces (which should
not occur under the strict dtype/shape policies enforced by the
per-class is_subspaceeq implementations) this degrades gracefully
to False: if both self.is_subspaceeq(other) and
other.is_subspaceeq(self) hold, the two spaces are considered
equivalent and neither is a STRICT subspace of the other.
If either side's is_subspaceeq is not implemented (the base
:meth:is_subspaceeq raises NotImplementedError), the exception
propagates to the caller — it is NOT swallowed into False so that
callers can tell that the comparison is unsupported.
Note: controller-required-space checks should typically use
:meth:is_subspaceeq (a controller's required space may exactly equal
the env space, in which case the strict is_subspace would return
False).