def add_generator_run(self,
generator_run: GeneratorRun,
multiplier: float = 1.0) -> Trial:
"""Add a generator run to the trial.
Note: since trial includes only one arm, this will raise a ValueError if
the generator run includes multiple arms.
Returns:
The trial instance.
"""
# Copy the generator run, to preserve initial and skip mutations to arms.
generator_run = generator_run.clone()
if len(generator_run.arms) > 1:
raise ValueError(
"Trial includes only one arm, but this generator run "
"included multiple.")
self.experiment.search_space.check_types(
generator_run.arms[0].parameters, raise_error=True)
self._check_existing_and_name_arm(generator_run.arms[0])
self._generator_run = generator_run
generator_run.index = 0
self._set_generation_step_index(
generation_step_index=generator_run._generation_step_index)
return self
def add_generator_run(self,
generator_run: GeneratorRun,
multiplier: float = 1.0) -> BatchTrial:
"""Add a generator run to the trial.
The arms and weights from the generator run will be merged with
the existing arms and weights on the trial, and the generator run
object will be linked to the trial for tracking.
Args:
generator_run: The generator run to be added.
multiplier: The multiplier applied to input weights before merging with
the current set of arms and weights.
Returns:
The trial instance.
"""
# Copy the generator run, to preserve initial and skip mutations to arms.
generator_run = generator_run.clone()
# First validate generator run arms
for arm in generator_run.arms:
self.experiment.search_space.check_types(arm.parameters,
raise_error=True)
# Add names to arms
# For those not yet added to this experiment, create a new name
# Else, use the name of the existing arm
for arm in generator_run.arms:
self._check_existing_and_name_arm(arm)
self._generator_run_structs.append(
GeneratorRunStruct(generator_run=generator_run, weight=multiplier))
generator_run.index = len(self._generator_run_structs) - 1
if self.status_quo is not None and self.optimize_for_power:
self.set_status_quo_and_optimize_power(
status_quo=not_none(self.status_quo))
self._set_generation_step_index(
generation_step_index=generator_run._generation_step_index)
self._refresh_arms_by_name()
return self
class GeneratorRunTest(TestCase):
def setUp(self):
self.model_predictions = get_model_predictions()
self.optimization_config = get_optimization_config()
self.search_space = get_search_space()
self.arms = get_arms()
self.weights = [2, 1, 1]
self.unweighted_run = GeneratorRun(
arms=self.arms,
optimization_config=self.optimization_config,
search_space=self.search_space,
model_predictions=self.model_predictions,
fit_time=4.0,
gen_time=10.0,
)
self.weighted_run = GeneratorRun(
arms=self.arms,
weights=self.weights,
optimization_config=self.optimization_config,
search_space=self.search_space,
model_predictions=self.model_predictions,
)
def testInit(self):
self.assertEqual(
len(self.unweighted_run.optimization_config.outcome_constraints),
len(self.optimization_config.outcome_constraints),
)
self.assertEqual(
len(self.unweighted_run.search_space.parameters),
len(self.search_space.parameters),
)
self.assertEqual(str(self.unweighted_run), GENERATOR_RUN_STR)
self.assertIsNotNone(self.unweighted_run.time_created)
self.assertEqual(self.unweighted_run.generator_run_type, None)
self.assertEqual(self.unweighted_run.fit_time, 4.0)
self.assertEqual(self.unweighted_run.gen_time, 10.0)
with self.assertRaises(ValueError):
GeneratorRun(
arms=self.arms,
weights=[],
optimization_config=self.optimization_config,
search_space=self.search_space,
)
with self.assertRaises(ValueError):
GeneratorRun(arms=self.arms, model_kwargs={"a": 1})
with self.assertRaises(ValueError):
GeneratorRun(arms=self.arms, model_key="b", bridge_kwargs={"a": 1})
# Check that an error will be raised if cand. metadata contains an arm
# signature that doesn't match any arms in generator run.
with self.assertRaisesRegex(ValueError, ".* in candidate metadata, but not"):
GeneratorRun(
arms=self.arms,
candidate_metadata_by_arm_signature={
"not_a_signature": {"md_key": "md_val"}
},
)
def testClone(self):
weighted_run2 = self.weighted_run.clone()
self.assertEqual(
self.weighted_run.optimization_config, weighted_run2.optimization_config
)
weighted_run2.arms[0].name = "bogus_name"
self.assertNotEqual(self.weighted_run.arms, weighted_run2.arms)
def testMergeDuplicateArm(self):
arms = self.arms + [self.arms[0]]
run = GeneratorRun(
arms=arms,
optimization_config=self.optimization_config,
search_space=self.search_space,
model_predictions=self.model_predictions,
)
self.assertEqual(str(run), GENERATOR_RUN_STR_PLUS_1)
def testIndex(self):
self.assertIsNone(self.unweighted_run.index)
self.unweighted_run.index = 1
with self.assertRaises(ValueError):
self.unweighted_run.index = 2
def testModelPredictions(self):
self.assertEqual(self.unweighted_run.model_predictions, get_model_predictions())
self.assertEqual(
self.unweighted_run.model_predictions_by_arm,
get_model_predictions_per_arm(),
)
run_no_model_predictions = GeneratorRun(
arms=self.arms,
weights=self.weights,
optimization_config=get_optimization_config(),
search_space=get_search_space(),
)
self.assertIsNone(run_no_model_predictions.model_predictions)
self.assertIsNone(run_no_model_predictions.model_predictions_by_arm)
def testEq(self):
self.assertEqual(self.unweighted_run, self.unweighted_run)
arms = [
Arm(parameters={"w": 0.5, "x": 15, "y": "foo", "z": False}),
Arm(parameters={"w": 1.4, "x": 2, "y": "bar", "z": True}),
]
unweighted_run_2 = GeneratorRun(
arms=arms,
optimization_config=self.optimization_config,
search_space=self.search_space,
)
self.assertNotEqual(self.unweighted_run, unweighted_run_2)
def testParamDf(self):
param_df = self.unweighted_run.param_df
self.assertEqual(len(param_df), len(self.arms))
def testBestArm(self):
generator_run = GeneratorRun(
arms=self.arms,
weights=self.weights,
optimization_config=get_optimization_config(),
search_space=get_search_space(),
best_arm_predictions=(self.arms[0], ({"a": 1.0}, {"a": {"a": 2.0}})),
)
self.assertEqual(
generator_run.best_arm_predictions,
(self.arms[0], ({"a": 1.0}, {"a": {"a": 2.0}})),
)
def testGenMetadata(self):
gm = {"hello": "world"}
generator_run = GeneratorRun(
arms=self.arms,
weights=self.weights,
optimization_config=get_optimization_config(),
search_space=get_search_space(),
gen_metadata=gm,
)
self.assertEqual(generator_run.gen_metadata, gm)
def test_split_by_arm(self):
gm = {"hello": "world"}
generator_run = GeneratorRun(
arms=self.arms,
weights=self.weights,
optimization_config=get_optimization_config(),
search_space=get_search_space(),
gen_metadata=gm,
)
generator_runs = generator_run.split_by_arm()
self.assertEqual(len(generator_runs), len(self.arms))
for a, w, gr in zip(self.arms, self.weights, generator_runs):
with self.subTest(a=a, w=w, gr=gr):
# Make sure correct arms and weights appear in split
# generator runs.
self.assertEqual(gr.arms, [a])
self.assertEqual(gr.weights, [w])
self.assertEqual(
gr._generator_run_type, generator_run._generator_run_type
)
self.assertEqual(gr._model_key, generator_run._model_key)
self.assertEqual(
gr._generation_step_index, generator_run._generation_step_index
)
self.assertIsNone(gr._optimization_config)
self.assertIsNone(gr._search_space)
self.assertIsNone(gr._gen_metadata)
class GeneratorRunTest(TestCase):
def setUp(self):
self.model_predictions = get_model_predictions()
self.optimization_config = get_optimization_config()
self.search_space = get_search_space()
self.arms = get_arms()
self.weights = [2, 1, 1]
self.unweighted_run = GeneratorRun(
arms=self.arms,
optimization_config=self.optimization_config,
search_space=self.search_space,
model_predictions=self.model_predictions,
fit_time=4.0,
gen_time=10.0,
)
self.weighted_run = GeneratorRun(
arms=self.arms,
weights=self.weights,
optimization_config=self.optimization_config,
search_space=self.search_space,
model_predictions=self.model_predictions,
)
def testInit(self):
self.assertEqual(
len(self.unweighted_run.optimization_config.outcome_constraints),
len(self.optimization_config.outcome_constraints),
)
self.assertEqual(
len(self.unweighted_run.search_space.parameters),
len(self.search_space.parameters),
)
self.assertEqual(str(self.unweighted_run), GENERATOR_RUN_STR)
self.assertIsNotNone(self.unweighted_run.time_created)
self.assertEqual(self.unweighted_run.generator_run_type, None)
self.assertEqual(self.unweighted_run.fit_time, 4.0)
self.assertEqual(self.unweighted_run.gen_time, 10.0)
with self.assertRaises(ValueError):
GeneratorRun(
arms=self.arms,
weights=[],
optimization_config=self.optimization_config,
search_space=self.search_space,
)
def testClone(self):
weighted_run2 = self.weighted_run.clone()
self.assertEqual(
self.weighted_run.optimization_config, weighted_run2.optimization_config
)
weighted_run2.arms[0].name = "bogus_name"
self.assertNotEqual(self.weighted_run.arms, weighted_run2.arms)
def testMergeDuplicateArm(self):
arms = self.arms + [self.arms[0]]
run = GeneratorRun(
arms=arms,
optimization_config=self.optimization_config,
search_space=self.search_space,
model_predictions=self.model_predictions,
)
self.assertEqual(str(run), GENERATOR_RUN_STR_PLUS_1)
def testIndex(self):
self.assertIsNone(self.unweighted_run.index)
self.unweighted_run.index = 1
with self.assertRaises(ValueError):
self.unweighted_run.index = 2
def testModelPredictions(self):
self.assertEqual(self.unweighted_run.model_predictions, get_model_predictions())
self.assertEqual(
self.unweighted_run.model_predictions_by_arm,
get_model_predictions_per_arm(),
)
run_no_model_predictions = GeneratorRun(
arms=self.arms,
weights=self.weights,
optimization_config=get_optimization_config(),
search_space=get_search_space(),
)
self.assertIsNone(run_no_model_predictions.model_predictions)
self.assertIsNone(run_no_model_predictions.model_predictions_by_arm)
def testEq(self):
self.assertEqual(self.unweighted_run, self.unweighted_run)
arms = [
Arm(parameters={"w": 0.5, "x": 15, "y": "foo", "z": False}),
Arm(parameters={"w": 1.4, "x": 2, "y": "bar", "z": True}),
]
unweighted_run_2 = GeneratorRun(
arms=arms,
optimization_config=self.optimization_config,
search_space=self.search_space,
)
self.assertNotEqual(self.unweighted_run, unweighted_run_2)
def testParamDf(self):
param_df = self.unweighted_run.param_df
self.assertEqual(len(param_df), len(self.arms))
def testBestArm(self):
generator_run = GeneratorRun(
arms=self.arms,
weights=self.weights,
optimization_config=get_optimization_config(),
search_space=get_search_space(),
best_arm_predictions=(self.arms[0], ({"a": 1.0}, {"a": {"a": 2.0}})),
)
self.assertEqual(
generator_run.best_arm_predictions,
(self.arms[0], ({"a": 1.0}, {"a": {"a": 2.0}})),
)