|
| 1 | +"""Defines extension mechanism for third party to hook into Orion""" |
| 2 | + |
| 3 | + |
| 4 | +class EventDelegate: |
| 5 | + """Allow extensions to listen to incoming events from Orion. |
| 6 | + Orion broadcasts events which trigger extensions callbacks. |
| 7 | +
|
| 8 | + Parameters |
| 9 | + ---------- |
| 10 | + name: str |
| 11 | + name of the event we are creating, this is useful for error reporting |
| 12 | +
|
| 13 | + deferred: bool |
| 14 | + if false events are triggered as soon as broadcast is called |
| 15 | + if true the events will need to be triggered manually |
| 16 | + """ |
| 17 | + def __init__(self, name, deferred=False) -> None: |
| 18 | + self.handlers = [] |
| 19 | + self.deferred_calls = [] |
| 20 | + self.name = name |
| 21 | + self.deferred = deferred |
| 22 | + self.bad_handlers = [] |
| 23 | + self.manager = None |
| 24 | + |
| 25 | + def remove(self, function) -> bool: |
| 26 | + """Remove an event handler from the handler list""" |
| 27 | + try: |
| 28 | + self.handlers.remove(function) |
| 29 | + return True |
| 30 | + except ValueError: |
| 31 | + return False |
| 32 | + |
| 33 | + def add(self, function): |
| 34 | + """Add an event handler to our handler list""" |
| 35 | + self.handlers.append(function) |
| 36 | + |
| 37 | + def broadcast(self, *args, **kwargs): |
| 38 | + """Broadcast and event to all our handlers""" |
| 39 | + if not self.deferred: |
| 40 | + self._execute(args, kwargs) |
| 41 | + return |
| 42 | + |
| 43 | + self.deferred_calls.append((args, kwargs)) |
| 44 | + |
| 45 | + def _execute(self, args, kwargs): |
| 46 | + for fun in self.handlers: |
| 47 | + try: |
| 48 | + fun(*args, **kwargs) |
| 49 | + except Exception as err: |
| 50 | + if self.manager: |
| 51 | + self.manager.on_extension_error.broadcast(self.name, fun, err, args=(args, kwargs)) |
| 52 | + |
| 53 | + def execute(self): |
| 54 | + """Execute all our deferred handlers if any""" |
| 55 | + for args, kwargs in self.deferred_calls: |
| 56 | + self._execute(args, kwargs) |
| 57 | + |
| 58 | + |
| 59 | +class _DelegateStartEnd: |
| 60 | + def __init__(self, start, error, end, *args, **kwargs): |
| 61 | + self.args = args |
| 62 | + self.kwargs = kwargs |
| 63 | + self.start = start |
| 64 | + self.end = end |
| 65 | + self.error = error |
| 66 | + |
| 67 | + def __enter__(self): |
| 68 | + self.start.broadcast(*self.args, **self.kwargs) |
| 69 | + return self |
| 70 | + |
| 71 | + def __exit__(self, exception_type, exception_value, exception_traceback): |
| 72 | + self.end.broadcast(*self.args, **self.kwargs) |
| 73 | + |
| 74 | + if exception_value is not None: |
| 75 | + self.error.broadcast( |
| 76 | + *self.args, |
| 77 | + exception_type, |
| 78 | + exception_value, |
| 79 | + exception_traceback, |
| 80 | + **self.kwargs |
| 81 | + ) |
| 82 | + |
| 83 | + |
| 84 | +class OrionExtensionManager: |
| 85 | + """Manages third party extensions for Orion""" |
| 86 | + |
| 87 | + def __init__(self): |
| 88 | + self._events = {} |
| 89 | + self._get_event('on_extension_error') |
| 90 | + |
| 91 | + # -- Trials |
| 92 | + self._get_event('new_trial') |
| 93 | + self._get_event('on_trial_error') |
| 94 | + self._get_event('end_trial') |
| 95 | + |
| 96 | + # -- Experiments |
| 97 | + self._get_event('start_experiment') |
| 98 | + self._get_event('on_experiment_error') |
| 99 | + self._get_event('end_experiment') |
| 100 | + |
| 101 | + def experiment(self, *args, **kwargs): |
| 102 | + """Initialize a context manager that will call start/error/end events automatically""" |
| 103 | + return _DelegateStartEnd( |
| 104 | + self.start_experiment, |
| 105 | + self.on_experiment_error, |
| 106 | + self.end_experiment, |
| 107 | + *args, |
| 108 | + **kwargs |
| 109 | + ) |
| 110 | + |
| 111 | + def trial(self, *args, **kwargs): |
| 112 | + """Initialize a context manager that will call start/error/end events automatically""" |
| 113 | + return _DelegateStartEnd( |
| 114 | + self.new_trial, |
| 115 | + self.on_trial_error, |
| 116 | + self.end_trial, |
| 117 | + *args, |
| 118 | + **kwargs |
| 119 | + ) |
| 120 | + |
| 121 | + def __getattr__(self, name): |
| 122 | + if name in self._events: |
| 123 | + return self._get_event(name) |
| 124 | + |
| 125 | + def _get_event(self, key): |
| 126 | + """Retrieve or generate a new event delegate""" |
| 127 | + delegate = self._events.get(key) |
| 128 | + |
| 129 | + if delegate is None: |
| 130 | + delegate = EventDelegate(key) |
| 131 | + delegate.manager = self |
| 132 | + self._events[key] = delegate |
| 133 | + |
| 134 | + return delegate |
| 135 | + |
| 136 | + def register(self, ext): |
| 137 | + """Register a new extensions |
| 138 | +
|
| 139 | + Parameters |
| 140 | + ---------- |
| 141 | + ext |
| 142 | + object implementing :class`OrionExtension` methods |
| 143 | +
|
| 144 | + Returns |
| 145 | + ------- |
| 146 | + the number of calls that was registered |
| 147 | + """ |
| 148 | + registered_callbacks = 0 |
| 149 | + for name, delegate in self._events.items(): |
| 150 | + if hasattr(ext, name): |
| 151 | + delegate.add(getattr(ext, name)) |
| 152 | + registered_callbacks += 1 |
| 153 | + |
| 154 | + return registered_callbacks |
| 155 | + |
| 156 | + def unregister(self, ext): |
| 157 | + """Remove an extensions if it was already registered""" |
| 158 | + unregistered_callbacks = 0 |
| 159 | + for name, delegate in self._events.items(): |
| 160 | + if hasattr(ext, name): |
| 161 | + delegate.remove(getattr(ext, name)) |
| 162 | + unregistered_callbacks += 1 |
| 163 | + |
| 164 | + return unregistered_callbacks |
| 165 | + |
| 166 | + |
| 167 | +class OrionExtension: |
| 168 | + """Base orion extension interface you need to implement""" |
| 169 | + |
| 170 | + def on_extension_error(self, name, fun, exception, args): |
| 171 | + """Called when an extension callbakc raise an exception |
| 172 | +
|
| 173 | + Parameters |
| 174 | + ---------- |
| 175 | + fun: callable |
| 176 | + handler that raised the error |
| 177 | +
|
| 178 | + exception: |
| 179 | + raised exception |
| 180 | +
|
| 181 | + args: tuple |
| 182 | + tuple of the arguments that were used |
| 183 | + """ |
| 184 | + return |
| 185 | + |
| 186 | + def on_trial_error(self, trial, exception_type, exception_value, exception_traceback): |
| 187 | + """Called when a error occur during the optimization process""" |
| 188 | + return |
| 189 | + |
| 190 | + def new_trial(self, trial): |
| 191 | + """Called when the trial starts with a new configuration""" |
| 192 | + return |
| 193 | + |
| 194 | + def end_trial(self, trial): |
| 195 | + """Called when the trial finished""" |
| 196 | + return |
| 197 | + |
| 198 | + def on_experiment_error(self, experiment, exception_type, exception_value, exception_traceback): |
| 199 | + """Called when a error occur during the optimization process""" |
| 200 | + return |
| 201 | + |
| 202 | + def start_experiment(self, experiment): |
| 203 | + """Called at the begin of the optimization process before the worker starts""" |
| 204 | + return |
| 205 | + |
| 206 | + def end_experiment(self, experiment): |
| 207 | + """Called at the end of the optimization process after the worker exits""" |
| 208 | + return |
| 209 | + |
0 commit comments