aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar Harald Husum <harahu@stud.ntnu.no>2018-03-08 08:24:12 +0100
committerGravatar Gunhan Gulsoy <gunan@google.com>2018-03-07 23:24:12 -0800
commitdef9013bcb037abf9112c0a44f6bc1d4f61e59fd (patch)
tree8c5312ccd1163e4fc1c305948d9458952f7f6e80
parent37f6d224d69edd532197d615ace872933be5d74b (diff)
Update TrainingSpec and EvalSpec pydoc (#17205)
Bring TrainingSpec and EvalSpec pydoc in line with pydoc of estimator.train() and evaluate()
-rw-r--r--tensorflow/python/estimator/training.py26
1 files changed, 20 insertions, 6 deletions
diff --git a/tensorflow/python/estimator/training.py b/tensorflow/python/estimator/training.py
index 2cc3331a15..e38b765da5 100644
--- a/tensorflow/python/estimator/training.py
+++ b/tensorflow/python/estimator/training.py
@@ -128,9 +128,16 @@ class TrainSpec(
"""Creates a validated `TrainSpec` instance.
Args:
- input_fn: Training input function returning a tuple of:
- features - `Tensor` or dictionary of string feature name to `Tensor`.
- labels - `Tensor` or dictionary of `Tensor` with labels.
+ input_fn: A function that provides input data for training as minibatches.
+ See @{$get_started/premade_estimators#create_input_functions} for more
+ information. The function should construct and return one of
+ the following:
+ * A 'tf.data.Dataset' object: Outputs of `Dataset` object must be a
+ tuple (features, labels) with same constraints as below.
+ * A tuple (features, labels): Where features is a `Tensor` or a
+ dictionary of string feature name to `Tensor` and labels is a
+ `Tensor` or a dictionary of string label name to `Tensor`.
+
max_steps: Int. Positive number of total steps for which to train model.
If `None`, train forever. The training `input_fn` is not expected to
generate `OutOfRangeError` or `StopIteration` exceptions. See the
@@ -185,9 +192,16 @@ class EvalSpec(
"""Creates a validated `EvalSpec` instance.
Args:
- input_fn: Evaluation input function returning a tuple of:
- features - `Tensor` or dictionary of string feature name to `Tensor`.
- labels - `Tensor` or dictionary of `Tensor` with labels.
+ input_fn: A function that constructs the input data for evaluation.
+ See @{$get_started/premade_estimators#create_input_functions} for more
+ information. The function should construct and return one of
+ the following:
+ * A 'tf.data.Dataset' object: Outputs of `Dataset` object must be a
+ tuple (features, labels) with same constraints as below.
+ * A tuple (features, labels): Where features is a `Tensor` or a
+ dictionary of string feature name to `Tensor` and labels is a
+ `Tensor` or a dictionary of string label name to `Tensor`.
+
steps: Int. Positive number of steps for which to evaluate model. If
`None`, evaluates until `input_fn` raises an end-of-input exception.
See `Estimator.evaluate` for details.