siml.path_like_objects.siml_files package

Submodules

siml.path_like_objects.siml_files.checkpoint_file module

class siml.path_like_objects.siml_files.checkpoint_file.SimlCheckpointFile(path: Path)

Bases: ISimlCheckpointFile

property epoch: int

property file_path: Path

property is_encrypted: bool

load(device: str, *, decrypt_key: bytes | None = None) → Any

save(dump_data: object, overwrite: bool = False, encrypt_key: bytes | None = None)

siml.path_like_objects.siml_files.interface module

class siml.path_like_objects.siml_files.interface.ISimlBaseFile(path: Path)

Bases: object

abstract property file_path: Path

abstract property is_encrypted: bool

class siml.path_like_objects.siml_files.interface.ISimlCheckpointFile(path: Path)

Bases: ISimlBaseFile

abstract property epoch: int

abstract load(device: str, *, decrypt_key: bytes | None = None) → dict

abstract save(dump_data: object, overwrite: bool = False, encrypt_key: bytes | None = None) → None

class siml.path_like_objects.siml_files.interface.ISimlNumpyFile(path: Path)

Bases: ISimlBaseFile

abstract property file_extension: str

abstract load(*, check_nan: bool = False, decrypt_key: bytes | None = None) → ndarray | coo_matrix | csr_matrix | csc_matrix

class siml.path_like_objects.siml_files.interface.ISimlPickleFile(path: Path)

Bases: ISimlBaseFile

abstract load(*, decrypt_key: bytes | None = None) → dict

abstract save(dump_data: object, overwrite: bool = False, encrypt_key: bytes | None = None) → None

class siml.path_like_objects.siml_files.interface.ISimlYamlFile(path: Path)

Bases: ISimlBaseFile

abstract load(*, decrypt_key: bytes | None = None) → dict

abstract save(dump_data: object, overwrite: bool = False, encrypt_key: bytes | None = None) → None

siml.path_like_objects.siml_files.numpy_file module

class siml.path_like_objects.siml_files.numpy_file.SimlNumpyFile(path: Path)

Bases: ISimlNumpyFile

property file_extension

property file_path: Path

property is_encrypted: bool

load(*, check_nan: bool = False, decrypt_key: bytes | None = None) → ndarray

save(data: ndarray | coo_matrix | csr_matrix | csc_matrix, *, encrypt_key: bytes | None = None, overwrite: bool = True) → None

siml.path_like_objects.siml_files.pickle_file module

class siml.path_like_objects.siml_files.pickle_file.SimlPickleFile(path: Path)

Bases: ISimlPickleFile

property file_path: Path

property is_encrypted: bool

load(*, decrypt_key: bytes | None = None) → dict

save(dump_data: object, overwrite: bool = False, encrypt_key: bytes | None = None)

siml.path_like_objects.siml_files.yaml_file module

class siml.path_like_objects.siml_files.yaml_file.SimlYamlFile(path: Path)

Bases: ISimlYamlFile

property file_path: Path

property is_encrypted: bool

load(*, decrypt_key: bytes | None = None) → dict

save(dump_data: object, overwrite: bool = False, encrypt_key: bytes | None = None)

Module contents