Skip to content

unienv_data.storages.transformation

Classes:

Name Description
TransformedStorage

TransformedStorage

TransformedStorage(
    single_instance_space: Space[Any, BDeviceType, BDtypeType, BRNGType],
    data_transformation: DataTransformation,
    inner_storage: SpaceStorage[
        BArrayType, BArrayType, BDeviceType, BDtypeType, BRNGType
    ],
    inner_storage_path: Union[str, PathLike],
    cache_filename: Optional[Union[str, PathLike]] = None,
)

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

Methods:

Name Description
create
load_from
extend_length
shrink_length
mark_segment_start
append
open_segment_writer
mark_segment_end
abort_segment
get_segments
get_flattened
get
set_flattened
set
clear
dumps
close

Attributes:

Name Type Description
single_file_ext
inner_storage
inner_storage_path
data_transformation
inv_data_transformation
cache_filename Optional[Union[str, PathLike]]
capacity Optional[int]
has_open_segment bool
pending_segment_length int
is_mutable bool
is_multiprocessing_safe bool
backend ComputeBackend[BArrayType, BDeviceType, BDtypeType, BRNGType]
device Optional[BDeviceType]
single_instance_space

single_file_ext class-attribute instance-attribute

single_file_ext = None

inner_storage instance-attribute

inner_storage = inner_storage

inner_storage_path instance-attribute

inner_storage_path = inner_storage_path

data_transformation instance-attribute

data_transformation = data_transformation

inv_data_transformation instance-attribute

inv_data_transformation = data_transformation.direction_inverse(single_instance_space)

cache_filename property

cache_filename: Optional[Union[str, PathLike]]

capacity property

capacity: Optional[int]

has_open_segment property

has_open_segment: bool

pending_segment_length property

pending_segment_length: int

is_mutable property

is_mutable: bool

is_multiprocessing_safe property

is_multiprocessing_safe: bool

backend property

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

device property

device: Optional[BDeviceType]

single_instance_space instance-attribute

single_instance_space = single_instance_space

create classmethod

create(
    single_instance_space: Space[Any, BDeviceType, BDtypeType, BRNGType],
    inner_storage_cls: Type[
        SpaceStorage[BArrayType, BArrayType, BDeviceType, BDtypeType, BRNGType]
    ],
    *args,
    data_transformation: DataTransformation,
    capacity: Optional[int] = None,
    cache_path: Optional[str] = None,
    multiprocessing: bool = False,
    inner_storage_kwargs: Dict[str, Any] = {},
    **kwargs,
) -> TransformedStorage[BArrayType, BDeviceType, BDtypeType, BRNGType]

load_from classmethod

load_from(
    path: Union[str, PathLike],
    single_instance_space: Space[Any, BDeviceType, BDtypeType, BRNGType],
    *,
    capacity: Optional[int] = None,
    read_only: bool = True,
    multiprocessing: bool = False,
    **kwargs,
) -> TransformedStorage[BArrayType, BDeviceType, BDtypeType, BRNGType]

extend_length

extend_length(length)

shrink_length

shrink_length(length)

mark_segment_start

mark_segment_start(start_index: int) -> None

append

append(value) -> None

open_segment_writer

open_segment_writer() -> SegmentWriter

mark_segment_end

mark_segment_end() -> None

abort_segment

abort_segment() -> None

get_segments

get_segments()

get_flattened

get_flattened(index)

get

get(index)

set_flattened

set_flattened(index, value)

set

set(index, value)

clear

clear()

dumps

dumps(path)

close

close()