Consumer¶
TODO
Evaluate objective on a set of parameters¶
Call user’s script as a black box process to evaluate a trial.
-
class
orion.core.worker.consumer.
Consumer
(experiment, heartbeat=None, user_script_config=None, interrupt_signal_code=None, ignore_code_changes=None)[source]¶ Consume a trial by using it to initialize a black-box box to evaluate it.
It uses an Experiment object to push an evaluated trial, if results are delivered to the worker process successfully.
It forks another process which executes user’s script with the suggested options. It expects results to be written in a JSON file, whose path has been defined in a special orion environmental variable which is set into the child process’ environment.
Parameters: - experiment: `orion.core.worker.experiment.Experiment`
Manager of this experiment, provides convenient interface for interacting with the database.
- heartbeat: int, optional
Frequency (seconds) at which the heartbeat of the trial is updated. If the heartbeat of a reserved trial is larger than twice the configured heartbeat, Oríon will reset the status of the trial to interrupted. This allows restoring lost trials (ex: due to killed worker). Defaults to
orion.core.config.worker.heartbeat
.- user_script_config: str, optional
Config argument name of user’s script (–config). Defaults to
orion.core.config.worker.user_script_config
.- interrupt_signal_code: int, optional
Signal returned by user script to signal to Oríon that it was interrupted. Defaults to
orion.core.config.worker.interrupt_signal_code
.
Methods
consume
(trial)Execute user’s script as a block box using the options contained within trial. execute_process
(cmd_args, environ)Facilitate launching a black-box trial. get_execution_environment
(trial[, results_file])Set a few environment variables to allow users and underlying processes to know if they are running under orion. -
consume
(trial)[source]¶ Execute user’s script as a block box using the options contained within trial.
Parameters: - trial: `orion.core.worker.trial.Trial`
Orion trial to execute.
Returns: - bool
True if the trial was successfully executed. False if the trial is broken.
-
get_execution_environment
(trial, results_file='results.log')[source]¶ Set a few environment variables to allow users and underlying processes to know if they are running under orion.
Parameters: - results_file: str
file used to store results, this is only used by the legacy protocol
- trial: Trial
reference to the trial object that is going to be run
Notes
This function defines the environment variables described below
-
ORION_EXPERIMENT_ID
Current experiment that is being ran.
-
ORION_EXPERIMENT_NAME
Name of the experiment the worker is currently working on.
-
ORION_EXPERIMENT_VERSION
Version of the experiment the worker is currently working on.
-
ORION_TRIAL_ID
Current trial id that is currently being executed in this process.
-
ORION_WORKING_DIRECTORY
Trial’s current working directory.
-
ORION_RESULTS_PATH
Trial’s results file that is read by the legacy protocol to get the results of the trial after a successful run.