palaestrai.entrypoints package#

Submodules#

palaestrai.entrypoints.palaestrai_runner module#

palaestrai.entrypoints.palaestrai_runner.execute(experiment_run_definition: ExperimentRun | TextIO | str | Path | List[ExperimentRun | TextIO | str | Path], runtime_config: str | TextIO | dict | None = None) → Tuple[List[str], ExecutorState][source]#

Provides a single-line command to start an experiment and set a runtime configuration

Parameters:

  • experiment_run_definition –

    1. Any text stream

      1. The path to a file

    The configuration from which the experiment is loaded.

  • runtime_config –

    1. dict

      1. None

    The Runtime configuration applicable for the run. Note that even when no additional source is provided, runtime will load a minimal configuration from build-in defaults.

Returns:

A tuple containing: 1. The list of all experiment run IDs 2. The final state of the executor

Return type:

Tuple[Sequence[str], ExecutorState]

Module contents#