sdq.io.Checkpoint#

class scdiffeq.io.Checkpoint(path: Path | str, *args, **kwargs)[source]#

Instantiates checkpoint object.

Parameters:

path (Union[Path, str]) – Path to saved checkpoint.

__init__(path: Path | str, *args, **kwargs) None[source]#

Instantiates checkpoint object.

Parameters:

path (Union[Path, str]) – Path to saved checkpoint.

property path: Path#

Returns: pathlib.Path The path to the checkpoint.

property version#

Returns: str Version of the checkpoint.

property F_hat#

Returns: pd.DataFrame or None DataFrame containing F_hat data if the path exists, otherwise None.

property epoch: int | str#

Returns: Union[int, str] Epoch number if not ‘last’, otherwise ‘last’.

property ckpt: Dict[str, LightningCheckpoint]#

Returns: Dict[str, “LightningCheckpoint”] State dictionary created by PyTorch Lightning.

__repr__() str[source]#
Returns:

str Object description of checkpoint at epoch.