aboutsummaryrefslogtreecommitdiffhomepage
path: root/tensorflow/python/estimator/estimator.py
diff options
context:
space:
mode:
Diffstat (limited to 'tensorflow/python/estimator/estimator.py')
-rw-r--r--tensorflow/python/estimator/estimator.py16
1 files changed, 9 insertions, 7 deletions
diff --git a/tensorflow/python/estimator/estimator.py b/tensorflow/python/estimator/estimator.py
index c04e37eccd..c394315cfa 100644
--- a/tensorflow/python/estimator/estimator.py
+++ b/tensorflow/python/estimator/estimator.py
@@ -94,13 +94,15 @@ class Estimator(object):
* Args:
- * `features`: single `Tensor` or `dict` of `Tensor`s
- (depending on data passed to `train`),
- * `labels`: `Tensor` or `dict` of `Tensor`s (for multi-head
- models). If mode is `ModeKeys.PREDICT`, `labels=None` will be
- passed. If the `model_fn`'s signature does not accept
- `mode`, the `model_fn` must still be able to handle
- `labels=None`.
+ * `features`: This is the first item returned from the `input_fn`
+ passed to `train`, 'evaluate`, and `predict`. This should be a
+ single `Tensor` or `dict` of same.
+ * `labels`: This is the second item returned from the `input_fn`
+ passed to `train`, 'evaluate`, and `predict`. This should be a
+ single `Tensor` or `dict` of same (for multi-head models). If
+ mode is `ModeKeys.PREDICT`, `labels=None` will be passed. If
+ the `model_fn`'s signature does not accept `mode`, the
+ `model_fn` must still be able to handle `labels=None`.
* `mode`: Optional. Specifies if this training, evaluation or
prediction. See `ModeKeys`.
* `params`: Optional `dict` of hyperparameters. Will receive what