sdq.io.Version#

class scdiffeq.io.Version(path: Path | str = None, groupby: str = 'epoch', *args, **kwargs)[source]#

scDiffEq Version object container

_path#

Path to the version within an scDiffEq project.

Type:

Union[Path, str]

_groupby#

Grouping method for metrics, default is “epoch”.

Type:

str

Instantiate Version by providing a path

Parameters:

  • path (Union[Path, str], optional) – Path to the version within an scDiffEq project, by default None.

  • groupby (str, optional) – Grouping method for metrics, by default “epoch”

Return type:

None

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

Instantiate Version by providing a path

Parameters:

  • path (Union[Path, str], optional) – Path to the version within an scDiffEq project, by default None.

  • groupby (str, optional) – Grouping method for metrics, by default “epoch”

Return type:

None

property hparams#

Check if the .yaml exists and instantiate the HParams class each time

Returns:

Instance of HParams class if hparams.yaml exists

Return type:

HParams

property metrics_df: DataFrame#

Check if metrics.csv path exists and read it

Returns:

DataFrame containing the metrics if metrics.csv exists

Return type:

pd.DataFrame

property per_epoch_metrics#

Group metrics by the specified groupby attribute

Returns:

Instance of GroupedMetrics class

Return type:

GroupedMetrics

property ckpts: Dict#

Format and update available checkpoints for the version

Returns:

Dictionary of checkpoints

Return type:

Dict

__repr__() → str[source]#

Return the name of the object

Returns:

Name of the object

Return type:

str