ray.tune.search.Searcher.on_trial_complete#

Searcher.on_trial_complete(trial_id: str, result: Dict | None = None, error: bool = False) → None[source]#

Notification for the completion of trial.

Typically, this method is used for notifying the underlying optimizer of the result.

Parameters:

  • trial_id – A unique string ID for the trial.

  • result – Dictionary of metrics for current training progress. Note that the result dict may include NaNs or may not include the optimization metric. It is up to the subclass implementation to preprocess the result to avoid breaking the optimization process. Upon errors, this may also be None.

  • error – True if the training process raised an error.