def create_experiment(name, version, space, **kwargs):
"""Instantiate the experiment and its attribute objects
All unspecified arguments will be replaced by system's defaults (orion.core.config.*).
Parameters
----------
name: str
Name of the experiment.
version: int
Version of the experiment.
space: dict or Space object
Optimization space of the algorithm. If dict, should have the form
`dict(name='<prior>(args)')`.
algorithms: str or dict, optional
Algorithm used for optimization.
strategy: str or dict, optional
Parallel strategy to use to parallelize the algorithm.
max_trials: int, optional
Maximum number or trials before the experiment is considered done.
storage: dict, optional
Configuration of the storage backend.
"""
experiment = Experiment(name=name, version=version)
experiment._id = kwargs.get('_id', None) # pylint:disable=protected-access
experiment.pool_size = kwargs.get('pool_size')
if experiment.pool_size is None:
experiment.pool_size = orion.core.config.experiment.get(
'pool_size', deprecated='ignore')
experiment.max_trials = kwargs.get('max_trials',
orion.core.config.experiment.max_trials)
experiment.space = _instantiate_space(space)
experiment.algorithms = _instantiate_algo(experiment.space,
kwargs.get('algorithms'))
experiment.producer = kwargs.get('producer', {})
experiment.producer['strategy'] = _instantiate_strategy(
experiment.producer.get('strategy'))
experiment.working_dir = kwargs.get(
'working_dir', orion.core.config.experiment.working_dir)
experiment.metadata = kwargs.get(
'metadata', {'user': kwargs.get('user', getpass.getuser())})
experiment.refers = kwargs.get('refers', {
'parent_id': None,
'root_id': None,
'adapter': []
})
experiment.refers['adapter'] = _instantiate_adapters(
experiment.refers.get('adapter', []))
return experiment
def test_experiment_stats():
"""Check that property stats is returning a proper summary of experiment's results."""
NUM_COMPLETED = 3
stati = (["completed"] * NUM_COMPLETED) + (["reserved"] * 2)
with OrionState(trials=generate_trials(stati)) as cfg:
exp = Experiment("supernaekei", mode="x")
exp._id = cfg.trials[0]["experiment"]
exp.metadata = {"datetime": datetime.datetime.utcnow()}
stats = exp.stats
assert stats.trials_completed == NUM_COMPLETED
assert stats.best_trials_id == cfg.trials[3]["_id"]
assert stats.best_evaluation == 0
assert stats.start_time == exp.metadata["datetime"]
assert stats.finish_time == cfg.trials[0]["end_time"]
assert stats.duration == stats.finish_time - stats.start_time
def test_experiment_stats():
"""Check that property stats is returning a proper summary of experiment's results."""
NUM_COMPLETED = 3
stati = (['completed'] * NUM_COMPLETED) + (['reserved'] * 2)
with OrionState(trials=generate_trials(stati)) as cfg:
exp = Experiment('supernaekei')
exp._id = cfg.trials[0]['experiment']
exp.metadata = {'datetime': datetime.datetime.utcnow()}
stats = exp.stats
assert stats['trials_completed'] == NUM_COMPLETED
assert stats['best_trials_id'] == cfg.trials[3]['_id']
assert stats['best_evaluation'] == 0
assert stats['start_time'] == exp.metadata['datetime']
assert stats['finish_time'] == cfg.trials[0]['end_time']
assert stats['duration'] == stats['finish_time'] - stats['start_time']
assert len(stats) == 6
def test_new_experiment_with_parent(self, create_db_instance, random_dt,
exp_config):
"""Configure a branch experiment."""
exp = Experiment('supernaedo2.6')
exp.metadata = exp_config[0][4]['metadata']
exp.refers = exp_config[0][4]['refers']
exp.algorithms = exp_config[0][4]['algorithms']
exp.configure(exp.configuration)
assert exp._init_done is True
assert_protocol(exp, create_db_instance)
assert exp._id is not None
assert exp.name == 'supernaedo2.6'
assert exp.configuration['refers'] == exp_config[0][4]['refers']
exp_config[0][4]['metadata']['datetime'] = random_dt
assert exp.metadata == exp_config[0][4]['metadata']
assert exp.pool_size is None
assert exp.max_trials is None
assert exp.configuration['algorithms'] == {'random': {'seed': None}}
def test_experiment_view_stats():
"""Check that property stats from view is consistent."""
NUM_COMPLETED = 3
stati = (['completed'] * NUM_COMPLETED) + (['reserved'] * 2)
with OrionState(trials=generate_trials(stati)) as cfg:
exp = Experiment('supernaekei')
exp._id = cfg.trials[0]['experiment']
exp.metadata = {'datetime': datetime.datetime.utcnow()}
exp_view = ExperimentView(exp)
stats = exp_view.stats
assert stats['trials_completed'] == NUM_COMPLETED
assert stats['best_trials_id'] == cfg.trials[3]['_id']
assert stats['best_evaluation'] == 0
assert stats['start_time'] == exp_view.metadata['datetime']
assert stats['finish_time'] == cfg.trials[0]['end_time']
assert stats['duration'] == stats['finish_time'] - stats['start_time']
assert len(stats) == 6
def create_experiment(name, version, mode, space, **kwargs):
"""Instantiate the experiment and its attribute objects
All unspecified arguments will be replaced by system's defaults (orion.core.config.*).
Parameters
----------
name: str
Name of the experiment.
version: int
Version of the experiment.
mode: str
The access rights of the experiment on the database.
'r': read access only
'w': can read and write to database
'x': can read and write to database, algo is instantiated and can execute optimization
space: dict or Space object
Optimization space of the algorithm. If dict, should have the form
`dict(name='<prior>(args)')`.
algorithms: str or dict, optional
Algorithm used for optimization.
strategy: str or dict, optional
Parallel strategy to use to parallelize the algorithm.
max_trials: int, optional
Maximum number or trials before the experiment is considered done.
max_broken: int, optional
Number of broken trials for the experiment to be considered broken.
storage: dict, optional
Configuration of the storage backend.
"""
experiment = Experiment(name=name, version=version, mode=mode)
experiment._id = kwargs.get("_id", None) # pylint:disable=protected-access
experiment.max_trials = kwargs.get("max_trials",
orion.core.config.experiment.max_trials)
experiment.max_broken = kwargs.get("max_broken",
orion.core.config.experiment.max_broken)
experiment.space = _instantiate_space(space)
experiment.algorithms = _instantiate_algo(
experiment.space,
experiment.max_trials,
kwargs.get("algorithms"),
ignore_unavailable=mode != "x",
)
# TODO: Remove for v0.4
_instantiate_strategy(kwargs.get("producer", {}).get("strategy"))
experiment.working_dir = kwargs.get(
"working_dir", orion.core.config.experiment.working_dir)
experiment.metadata = kwargs.get(
"metadata", {"user": kwargs.get("user", getpass.getuser())})
experiment.refers = kwargs.get("refers", {
"parent_id": None,
"root_id": None,
"adapter": []
})
experiment.refers["adapter"] = _instantiate_adapters(
experiment.refers.get("adapter", []))
log.debug("Created experiment with config:\n%s",
pprint.pformat(experiment.configuration))
return experiment
