openfl.component.director.experiment.ExperimentsRegistry

class openfl.component.director.experiment.ExperimentsRegistry

Bases: object

ExperimentsList class.

__init__()

Initialize an experiments list object.

Return type:

None

Methods

__init__()	Initialize an experiments list object.
add(experiment)	Add experiment to queue of not started experiments.
finish_active()	Finish active experiment.
get(key[, default])	Get experiment by name.
get_next_experiment()	Context manager.
get_user_experiments(user)	Get list of experiments for specific user.
remove(name)	Remove experiment from everywhere.

Attributes

active_experiment	Get active experiment.
pending_experiments	Get queue of not started experiments.

property active_experiment: Experiment | None

Get active experiment.

Returns:

The active experiment if exists, None

otherwise.

Return type:

Union[Experiment, None]

add(experiment)

Add experiment to queue of not started experiments.

Parameters:

experiment (Experiment) – The experiment to add.

Return type:

None

finish_active()

Finish active experiment.

Return type:

None

get(key, default=None)

Get experiment by name.

Parameters:

• key (str) – The name of the experiment.

• default (optional) – The default value to return if the experiment does not exist.

Returns:

The experiment with the given name, or the default

value if the experiment does not exist.

Return type:

Experiment

get_next_experiment()

Context manager.

On enter get experiment from pending_experiments. On exit put finished experiment to archive_experiments.

get_user_experiments(user)

Get list of experiments for specific user.

Parameters:

user (str) – The name of the user.

Returns:

The list of experiments for the specific user.

Return type:

List[Experiment]

property pending_experiments: List[str]

Get queue of not started experiments.

Returns:

The list of pending experiments.

Return type:

List[str]

remove(name)

Remove experiment from everywhere.

Parameters:

name (str) – The name of the experiment to remove.

Return type:

None