Source code for optuna.integration.tensorflow

import optuna

if optuna.type_checking.TYPE_CHECKING:
    from typing import Optional  # NOQA

try:
    import tensorflow as tf
    from tensorflow.estimator import SessionRunHook
    from tensorflow_estimator.python.estimator.early_stopping import read_eval_metrics

    _available = True
except ImportError as e:
    _import_error = e
    # TensorFlowPruningHook is disabled because TensorFlow is not available.
    _available = False
    SessionRunHook = object


[docs]class TensorFlowPruningHook(SessionRunHook): """TensorFlow SessionRunHook to prune unpromising trials. Example: See `the example <https://github.com/optuna/optuna/blob/30dba8814d332ff4 0d9c7465ee660a8ecf499547/examples/tensorflow_estimator_simple.py>`_ if you want to add a pruning SessionRunHook for TensorFlow's Estimator. Args: trial: A :class:`~optuna.trial.Trial` corresponding to the current evaluation of the objective function. estimator: An estimator which you will use. metric: An evaluation metric for pruning, e.g., ``accuracy`` and ``loss``. run_every_steps: An interval to watch the summary file. is_higher_better: Please do not use this argument because this class refers to :class:`~optuna.structs.StudyDirection` to check whether the current study is ``minimize`` or ``maximize``. """ def __init__(self, trial, estimator, metric, run_every_steps, is_higher_better=None): # type: (optuna.trial.Trial, tf.estimator.Estimator, str, int, Optional[bool]) -> None _check_tensorflow_availability() self._trial = trial self._estimator = estimator self._current_summary_step = -1 self._metric = metric self._global_step_tensor = None self._timer = tf.estimator.SecondOrStepTimer(every_secs=None, every_steps=run_every_steps) if is_higher_better is not None: raise ValueError( "Please do not use is_higher_better argument of " "TensorFlowPruningHook.__init__(). is_higher_better argument " "is obsolete since Optuna 0.9.0." ) def begin(self): # type: () -> None self._global_step_tensor = tf.compat.v1.train.get_global_step() def before_run(self, run_context): # type: (tf.estimator.SessionRunContext) -> tf.estimator.SessionRunArgs del run_context return tf.estimator.SessionRunArgs(self._global_step_tensor) def after_run(self, run_context, run_values): # type: (tf.estimator.SessionRunContext, tf.estimator.SessionRunValues) -> None global_step = run_values.results # Get eval metrics every n steps. if self._timer.should_trigger_for_step(global_step): self._timer.update_last_triggered_step(global_step) eval_metrics = read_eval_metrics(self._estimator.eval_dir()) else: eval_metrics = None if eval_metrics: summary_step = next(reversed(eval_metrics)) latest_eval_metrics = eval_metrics[summary_step] # If there exists a new evaluation summary. if summary_step > self._current_summary_step: current_score = latest_eval_metrics[self._metric] if current_score is None: current_score = float("nan") self._trial.report(float(current_score), step=summary_step) self._current_summary_step = summary_step if self._trial.should_prune(): message = "Trial was pruned at iteration {}.".format(self._current_summary_step) raise optuna.exceptions.TrialPruned(message)
def _check_tensorflow_availability(): # type: () -> None if not _available: raise ImportError( "TensorFlow is not available. Please install TensorFlow to use this feature. " "TensorFlow can be installed by executing `$ pip install tensorflow`. " "For further information, please refer to the installation guide of TensorFlow. " "(The actual import error is as follows: " + str(_import_error) + ")" )