deephyper.evaluator.RunningJob#

class deephyper.evaluator.RunningJob(id: Hashable = None, parameters: dict = None, storage: Storage = None, stopper: Stopper = None)[source]#

Bases: MutableMapping

A RunningJob is adapted Job object that is passed to the run-function as input.

Parameters:

  • id (Hashable, optional) – The identifier of the job in the Storage. Defaults to None.

  • parameters (dict, optional) – The dictionnary of hyperparameters suggested. Defaults to None.

  • storage (Storage, optional) – The storage client used for the search. Defaults to None.

  • stopper (Stopper, optional) – The stopper object used for the evaluation. Defaults to None.

Methods

clear

get

items

keys

pop

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem

as a 2-tuple; but raise KeyError if D is empty.

record

Records the current budget and objective values in the object and pass it to the stopper if one is being used.

setdefault

stopped

Returns True if the RunningJob is using a Stopper and it is stopped.

update

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values

Attributes

objective

If the RunningJob is using a Stopper then it will return observations from the it.
clear() → None.  Remove all items from D.#
get(k[, d]) → D[k] if k in D, else d.  d defaults to None.#
items() → a set-like object providing a view on D's items#
keys() → a set-like object providing a view on D's keys#
property objective#

If the RunningJob is using a Stopper then it will return observations from the it. Otherwise it will simply return the last objective value recorded.

pop(k[, d]) → v, remove specified key and return the corresponding value.#

If key is not found, d is returned if given, otherwise KeyError is raised.

popitem() → (k, v), remove and return some (key, value) pair#

as a 2-tuple; but raise KeyError if D is empty.

record(budget: float, objective: float)[source]#

Records the current budget and objective values in the object and pass it to the stopper if one is being used.

Parameters:

  • budget (float) – the budget used.

  • objective (float) – the objective value obtained.

setdefault(k[, d]) → D.get(k,d), also set D[k]=d if k not in D#
stopped() → bool[source]#

Returns True if the RunningJob is using a Stopper and it is stopped. Otherwise it will return False.

update([E, ]**F) → None.  Update D from mapping/iterable E and F.#

If E present and has a .keys() method, does: for k in E: D[k] = E[k] If E present and lacks .keys() method, does: for (k, v) in E: D[k] = v In either case, this is followed by: for k, v in F.items(): D[k] = v

values() → an object providing a view on D's values#