sdq.io.Project#

class scdiffeq.io.Project(path: str | Path = PosixPath('/home/runner/work/scDiffEq/scDiffEq/docs/source'), metrics_groupby: str = 'epoch', *args, **kwargs)[source]#

Object container for an scDiffEq project

path#

Path to the project, created by scDiffeq.

Type:

Union[str, Path]

metrics_groupby#

Grouping method for metrics, default is “epoch”.

Type:

str

Initialize the project object by providing a path.

Parameters:

  • path (Union[str, Path], optional) – Path to the project, created by scDiffeq, by default pathlib.Path(“./”).absolute()

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

Returns:

None

__init__(path: str | Path = PosixPath('/home/runner/work/scDiffEq/scDiffEq/docs/source'), metrics_groupby: str = 'epoch', *args, **kwargs) → None[source]#

Initialize the project object by providing a path.

Parameters:

  • path (Union[str, Path], optional) – Path to the project, created by scDiffeq, by default pathlib.Path(“./”).absolute()

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

Returns:

None

_set_version_path_attributes() → None[source]#

Sets the name of each version as a class attribute, pointing to the path of the version.

__getitem__(version: int) → Path[source]#

Format version key and return version

Parameters:

version (int) – Version number

Returns:

pathlib.Path Path to the specified version