`unienv_data.batches.subitem_batch`¶

SubItemBatch ¶

SubItemBatch(batch: BatchBase[BatchT, BArrayType, BDeviceType, BDtypeType, BRNGType], sub_indexes: Sequence[Any])

Bases: BatchBase[BatchT, BArrayType, BDeviceType, BDtypeType, BRNGType]

A batch that offers a view of the original batch with a fixed index. This is a read-only batch, since it is a view of the original batch. If you want to change the data, you should mutate the containing batch instead.

is_mutable `class-attribute` `instance-attribute` ¶

is_mutable = False

batch `instance-attribute` ¶

batch = batch

sub_indexes `instance-attribute` ¶

sub_indexes = sub_indexes

backend `property` ¶

backend: ComputeBackend[BArrayType, BDeviceType, BDtypeType, BRNGType]

device `property` ¶

device: Optional[BDeviceType]

single_space `instance-attribute` ¶

single_space = single_space

single_metadata_space `instance-attribute` ¶

single_metadata_space = single_metadata_space

get_flattened_at ¶

get_flattened_at(idx)

get_flattened_at_with_metadata ¶

get_flattened_at_with_metadata(idx)

get_at ¶

get_at(idx)

get_at_with_metadata ¶

get_at_with_metadata(idx) -> Tuple[BatchT, Dict[str, Any]]

close ¶

close() -> None

set_flattened_at ¶

set_flattened_at(idx: Union[IndexableType, BArrayType], value: BArrayType) -> None

Overwrite existing samples using flattened data.

append_flattened ¶

append_flattened(value: BArrayType) -> None

Append one flattened sample to the batch.

extend_flattened ¶

extend_flattened(value: BArrayType) -> None

Append a batched block of flattened samples.

set_at ¶

set_at(idx: Union[IndexableType, BArrayType], value: BatchT) -> None

Overwrite existing samples using structured data.

remove_at ¶

remove_at(idx: Union[IndexableType, BArrayType]) -> None

Remove one or more samples from the batch.

append ¶

append(value: BatchT) -> None

Append one structured sample to the batch.

extend ¶

extend(value: BatchT) -> None

Append a batched block of structured samples.

extend_from ¶

extend_from(other: BatchBase[BatchT, BArrayType, BDeviceType, BDtypeType, BRNGType], chunk_size: int = 8, tqdm: bool = False) -> None

Copy data from another batch in bounded-size chunks.

get_slice ¶

get_slice(idx: Union[IndexableType, BArrayType]) -> BatchBase[BatchT, BArrayType, BDeviceType, BDtypeType, BRNGType]

Create a lazy view over a subset of indices.

get_column ¶

get_column(nested_keys: Sequence[str]) -> BatchBase[Any, BArrayType, BDeviceType, BDtypeType, BRNGType]

Create a lazy view over a nested field inside each sample.

recursive_index ¶

recursive_index(space_or_data: Union[BatchT, Space], index: Sequence[Any]) -> Union[BatchT, Space]

unienv_data.batches.subitem_batch¶