Skip to content

unienv_interface.utils.framestack_queue

Classes:

Name Description
SpaceDataQueueState
FuncSpaceDataQueue
SpaceDataQueue

Attributes:

Name Type Description
DataT

DataT module-attribute

DataT = TypeVar('DataT')

SpaceDataQueueState dataclass

SpaceDataQueueState(data: DataT)

Bases: Generic[DataT]

Methods:

Name Description
replace

Attributes:

Name Type Description
data DataT

data instance-attribute

data: DataT

replace

replace(**changes: Any) -> SpaceDataQueueState

FuncSpaceDataQueue

FuncSpaceDataQueue(
    space: Space[DataT, BDeviceType, BDtypeType, BRNGType],
    batch_size: Optional[int],
    maxlen: int,
)

Bases: Generic[DataT, BArrayType, BDeviceType, BDtypeType, BRNGType]

Methods:

Name Description
init
reset
add
get_output_data

Attributes:

Name Type Description
single_space
stacked_space
output_space
maxlen int
batch_size Optional[int]
backend ComputeBackend
device Optional[BDeviceType]

single_space instance-attribute

single_space = space

stacked_space instance-attribute

stacked_space = sbu.batch_space(space, maxlen)

output_space instance-attribute

output_space = (
    sbu.swap_batch_dims(self.stacked_space, 0, 1)
    if batch_size is not None
    else self.stacked_space
)

maxlen property

maxlen: int

batch_size property

batch_size: Optional[int]

backend property

backend: ComputeBackend

device property

device: Optional[BDeviceType]

init

init(initial_data: DataT) -> SpaceDataQueueState

reset

reset(
    state: SpaceDataQueueState, initial_data: DataT, mask: Optional[BArrayType] = None
) -> SpaceDataQueueState

add

get_output_data

get_output_data(state: SpaceDataQueueState) -> DataT

SpaceDataQueue

SpaceDataQueue(
    space: Space[DataT, BDeviceType, BDtypeType, BRNGType],
    batch_size: Optional[int],
    maxlen: int,
)

Bases: Generic[DataT, BArrayType, BDeviceType, BDtypeType, BRNGType]

Methods:

Name Description
reset
add
get_output_data

Attributes:

Name Type Description
func_queue
state
single_space Space[DataT, BDeviceType, BDtypeType, BRNGType]
stacked_space Space[DataT, BDeviceType, BDtypeType, BRNGType]
output_space Space[DataT, BDeviceType, BDtypeType, BRNGType]
maxlen int
batch_size Optional[int]
backend ComputeBackend
device Optional[BDeviceType]

func_queue instance-attribute

func_queue = FuncSpaceDataQueue(space, batch_size, maxlen)

state instance-attribute

state = None

single_space property

single_space: Space[DataT, BDeviceType, BDtypeType, BRNGType]

stacked_space property

stacked_space: Space[DataT, BDeviceType, BDtypeType, BRNGType]

output_space property

output_space: Space[DataT, BDeviceType, BDtypeType, BRNGType]

maxlen property

maxlen: int

batch_size property

batch_size: Optional[int]

backend property

backend: ComputeBackend

device property

device: Optional[BDeviceType]

reset

reset(initial_data: DataT, mask: Optional[BArrayType] = None) -> None

add

add(data: DataT) -> None

get_output_data

get_output_data() -> DataT