Experiment Group#

class ExperimentGroup(name: str, datasets: List[str | Tuple[str, str]], data_config: Dict[str, Any] | None = None, algorithms: List[str] | None = None, algorithm_config: Dict[str, Dict[str, Any]] | None = None, description: str | None = '', workflow_args: Dict[str, Any] | None = None)#

Container for experiment group configuration.

Parameters:
namestr

Unique identifier for the experiment group

datasetslist

List of dataset filenames relative to project’s datasets directory

data_configdict, optional

Arguments for DataManager

algorithmslist, optional

List of algorithms to use

algorithm_configdict, optional

Arguments to apply to AlgorithmWrappers

descriptionstr, optional

Description for the experiment group

workflow_argsdict, optional

Arguments to pass to workflow as attributes

property dataset_paths: List[Tuple[Path, str | None]]#

Get full paths to datasets relative to project root.

Returns:
list of (pathlib.Path, str or None)

Each tuple contains:

  • pathpathlib.Path

    Full path to the dataset file

  • table_namestr or None

    Name of table for database files, None for regular files

Raises:
FileNotFoundError

If project root (.briskconfig) cannot be found