Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[tune] Fix trial runner/controller whitelist attributes #35769

Merged
merged 8 commits into from
Jun 1, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions python/ray/tune/execution/trial_runner.py
Original file line number Diff line number Diff line change
Expand Up @@ -1314,8 +1314,20 @@ def _wrapped(self):
return TrialRunnerWrapper(
self,
self.trial_executor,
runner_whitelist_attr={"search_alg", "get_trials", "_set_trial_status"},
executor_whitelist_attr={"has_resources_for_trial", "pause_trial", "save"},
runner_whitelist_attr={
"search_alg",
"get_trials",
"get_live_trials",
"_set_trial_status",
"pause_trial",
"stop_trial",
},
executor_whitelist_attr={
"has_resources_for_trial",
"pause_trial",
"save",
"_resource_updater",
},
)

def update_max_pending_trials(self, max_pending_trials: Optional[int] = None):
Expand Down Expand Up @@ -1545,6 +1557,9 @@ def __init__(
self._trial_executor = trial_executor
self._whitelist_attr = whitelist_attr or set()

for attr in self._whitelist_attr:
assert hasattr(self._trial_executor, attr)

def __getattr__(self, attr):
if attr not in self._whitelist_attr:
if log_once("restrict_accessing_trial_executor"):
Expand Down Expand Up @@ -1584,6 +1599,9 @@ def __init__(
)
self._runner_whitelist_attr = runner_whitelist_attr or set()

for attr in self._runner_whitelist_attr:
assert hasattr(self, attr)

def __getattr__(self, attr):
if attr == self._EXECUTOR_ATTR:
return self._trial_executor
Expand Down
16 changes: 14 additions & 2 deletions python/ray/tune/execution/tune_controller.py
Original file line number Diff line number Diff line change
Expand Up @@ -154,8 +154,20 @@ def _wrapped(self):
return TrialRunnerWrapper(
self,
trial_executor=_FakeRayTrialExecutor(self),
runner_whitelist_attr={"search_alg", "get_trials", "_set_trial_status"},
executor_whitelist_attr={"has_resources_for_trial", "pause_trial", "save"},
runner_whitelist_attr={
justinvyu marked this conversation as resolved.
Show resolved Hide resolved
"search_alg",
justinvyu marked this conversation as resolved.
Show resolved Hide resolved
"get_trials",
"get_live_trials",
"_set_trial_status",
"pause_trial",
"stop_trial",
},
executor_whitelist_attr={
"has_resources_for_trial",
"pause_trial",
"save",
justinvyu marked this conversation as resolved.
Show resolved Hide resolved
"_resource_updater",
},
)

def _used_resources_string(self) -> str:
Expand Down
6 changes: 3 additions & 3 deletions python/ray/tune/schedulers/hb_bohb.py
Original file line number Diff line number Diff line change
Expand Up @@ -109,16 +109,16 @@ def on_trial_result(
# as intended.
# There should be a better API for this.
# TODO(team-ml): Refactor alongside HyperBandForBOHB
trial_runner._search_alg.searcher.on_pause(trial.trial_id)
trial_runner.search_alg.searcher.on_pause(trial.trial_id)
return TrialScheduler.PAUSE
action = self._process_bracket(trial_runner, bracket)
if action == TrialScheduler.PAUSE:
trial_runner._search_alg.searcher.on_pause(trial.trial_id)
trial_runner.search_alg.searcher.on_pause(trial.trial_id)
return action

def _unpause_trial(self, trial_runner: "trial_runner.TrialRunner", trial: Trial):
# Hack. See comment in on_trial_result
trial_runner._search_alg.searcher.on_unpause(trial.trial_id)
trial_runner.search_alg.searcher.on_unpause(trial.trial_id)

def choose_trial_to_run(
self, trial_runner: "trial_runner.TrialRunner", allow_recurse: bool = True
Expand Down
22 changes: 11 additions & 11 deletions python/ray/tune/tests/test_trial_scheduler.py
Original file line number Diff line number Diff line change
Expand Up @@ -733,8 +733,8 @@ def result(score, ts):
metric="episode_reward_mean", mode="max", max_t=3, reduction_factor=3
)
runner = _MockTrialRunner(sched)
runner._search_alg = MagicMock()
runner._search_alg.searcher = MagicMock()
runner.search_alg = MagicMock()
runner.search_alg.searcher = MagicMock()
trials = [Trial("__fake") for i in range(3)]
for t in trials:
runner.add_trial(t)
Expand All @@ -748,8 +748,8 @@ def result(score, ts):
decision = sched.on_trial_result(runner, trials[-1], spy_result)
self.assertEqual(decision, TrialScheduler.STOP)
sched.choose_trial_to_run(runner)
self.assertEqual(runner._search_alg.searcher.on_pause.call_count, 2)
self.assertEqual(runner._search_alg.searcher.on_unpause.call_count, 1)
self.assertEqual(runner.search_alg.searcher.on_pause.call_count, 2)
self.assertEqual(runner.search_alg.searcher.on_unpause.call_count, 1)
self.assertTrue("hyperband_info" in spy_result)
self.assertEqual(spy_result["hyperband_info"]["budget"], 1)

Expand All @@ -761,8 +761,8 @@ def result(score, ts):
metric="episode_reward_mean", mode="min", max_t=3, reduction_factor=3
)
runner = _MockTrialRunner(sched)
runner._search_alg = MagicMock()
runner._search_alg.searcher = MagicMock()
runner.search_alg = MagicMock()
runner.search_alg.searcher = MagicMock()
trials = [Trial("__fake") for i in range(3)]
for t in trials:
runner.add_trial(t)
Expand All @@ -776,7 +776,7 @@ def result(score, ts):
decision = sched.on_trial_result(runner, trials[-1], spy_result)
self.assertEqual(decision, TrialScheduler.CONTINUE)
sched.choose_trial_to_run(runner)
self.assertEqual(runner._search_alg.searcher.on_pause.call_count, 2)
self.assertEqual(runner.search_alg.searcher.on_pause.call_count, 2)
self.assertTrue("hyperband_info" in spy_result)
self.assertEqual(spy_result["hyperband_info"]["budget"], 1)

Expand All @@ -788,8 +788,8 @@ def result(score, ts):
metric="episode_reward_mean", mode="min", max_t=10, reduction_factor=3
)
runner = _MockTrialRunner(sched)
runner._search_alg = MagicMock()
runner._search_alg.searcher = MagicMock()
runner.search_alg = MagicMock()
runner.search_alg.searcher = MagicMock()
trials = [Trial("__fake") for i in range(3)]
for t in trials:
runner.add_trial(t)
Expand Down Expand Up @@ -2344,8 +2344,8 @@ def testBOHBNanInf(self):
scheduler = HyperBandForBOHB(metric="episode_reward_mean", mode="max")

runner = _MockTrialRunner(scheduler)
runner._search_alg = MagicMock()
runner._search_alg.searcher = MagicMock()
runner.search_alg = MagicMock()
runner.search_alg.searcher = MagicMock()

t1, t2, t3 = self.nanInfSetup(scheduler, runner)
# skip trial complete in this mock setting
Expand Down