aboutsummaryrefslogtreecommitdiffhomepage
path: root/tensorflow/contrib/learn
diff options
context:
space:
mode:
authorGravatar A. Unique TensorFlower <gardener@tensorflow.org>2018-05-08 08:57:45 -0700
committerGravatar TensorFlower Gardener <gardener@tensorflow.org>2018-05-08 14:05:12 -0700
commit4a6e6632eb866a2910396c6bc78d601b5b9b550e (patch)
treec2e194404708287e8df955fe79031eab1c61acb7 /tensorflow/contrib/learn
parenta6a862e90d1b336570ab67816ca14e191f5acb32 (diff)
Update comment clarifying continuous eval behavior.
PiperOrigin-RevId: 195826025
Diffstat (limited to 'tensorflow/contrib/learn')
-rw-r--r--tensorflow/contrib/learn/python/learn/experiment.py13
1 files changed, 9 insertions, 4 deletions
diff --git a/tensorflow/contrib/learn/python/learn/experiment.py b/tensorflow/contrib/learn/python/learn/experiment.py
index 3744abd860..dfc6a393d0 100644
--- a/tensorflow/contrib/learn/python/learn/experiment.py
+++ b/tensorflow/contrib/learn/python/learn/experiment.py
@@ -468,10 +468,15 @@ class Experiment(object):
on which that evaluation was based.
At the beginning of evaluation, the passed `eval_results` will be None
so it's expected that the predicate function handles that gracefully.
- When `predicate_fn` is not specified, continuous eval will run in an
- infinite loop (if `train_steps` is None). or exit once global step
- reaches `train_steps`.
-
+ Continuous eval behavior under different conditions:
+ * When `predicate_fn` is specified:
+ + if `train_steps` is None, run until `predicate_fn` returns False.
+ + if `train_steps` is specified, run until either global step
+ reaches `train_steps` or `predicate_fn` returns False.
+ * When `predicate_fn` is not specified:
+ + if `train_steps` is None, run in an infinite loop.
+ + if `train_steps` is specified, run until global step reaches
+ `train_steps`.
export: Whether to export from this step. Default is 'True'.
Raises: