neuralib.persistence.persistence.PickleHandler

class neuralib.persistence.persistence.PickleHandler

Bases: PersistenceHandler[T]

Support field type: all python objects.

__init__(data_cls, save_root, ext='.pkl')

Parameters:

• data_cls (type[T])

• save_root (Path)

• ext (str)

Methods

__init__(data_cls, save_root[, ext])
filename(result, **kwargs)	build filename for persistence instance.
filepath(result, **kwargs)	build filepath for persistence instance.
load_all(result, **kwargs)	load all persistent result under save_root.
load_persistence(path)	Load data as data_cls from path without validation.
save_persistence(result[, path])	save persistence result under path.
validate(ref, res)

Attributes

persistence_class
persistence_info	information for persistence class
save_root	saving directory

__init__(data_cls, save_root, ext='.pkl')

Parameters:

• data_cls (type[T])

• save_root (Path)

• ext (str)

property persistence_class: type[T]

Returns:

type T

property save_root: Path

saving directory

filename(result, **kwargs)

build filename for persistence instance.

Parameters:

• result (T | None) – persistence instance

• kwargs – overwrite field value in result.

Returns:

file name of result, may contains ‘{}’ if result’s autoinc field not resolved

Return type:

str