Fixes the wording about StopIteration.
PiperOrigin-RevId: 168034451
This commit is contained in:
parent
fb5588002b
commit
82cc6529f4
@ -211,17 +211,17 @@ class Estimator(object):
|
|||||||
hooks: List of `SessionRunHook` subclass instances. Used for callbacks
|
hooks: List of `SessionRunHook` subclass instances. Used for callbacks
|
||||||
inside the training loop.
|
inside the training loop.
|
||||||
steps: Number of steps for which to train model. If `None`, train forever
|
steps: Number of steps for which to train model. If `None`, train forever
|
||||||
or train until input_fn generates the `OutOfRange` or `StopIteration`
|
or train until input_fn generates the `OutOfRange` error or
|
||||||
error. 'steps' works incrementally. If you call two times
|
`StopIteration` exception. 'steps' works incrementally. If you call two
|
||||||
train(steps=10) then training occurs in total 20 steps. If `OutOfRange`
|
times train(steps=10) then training occurs in total 20 steps. If
|
||||||
or `StopIteration` error occurs in the middle, training stops before 20
|
`OutOfRange` or `StopIteration` occurs in the middle, training stops
|
||||||
steps. If you don't want to have incremental behavior please set
|
before 20 steps. If you don't want to have incremental behavior please
|
||||||
`max_steps` instead. If set, `max_steps` must be `None`.
|
set `max_steps` instead. If set, `max_steps` must be `None`.
|
||||||
max_steps: Number of total steps for which to train model. If `None`,
|
max_steps: Number of total steps for which to train model. If `None`,
|
||||||
train forever or train until input_fn generates the `OutOfRange` or
|
train forever or train until input_fn generates the `OutOfRange` error
|
||||||
`StopIteration` error. If set, `steps` must be `None`. If `OutOfRange`
|
or `StopIteration` exception. If set, `steps` must be `None`. If
|
||||||
or `StopIteration` error occurs in the middle, training stops before
|
`OutOfRange` or `StopIteration` occurs in the middle, training stops
|
||||||
`max_steps` steps.
|
before `max_steps` steps.
|
||||||
|
|
||||||
Two calls to `train(steps=100)` means 200 training
|
Two calls to `train(steps=100)` means 200 training
|
||||||
iterations. On the other hand, two calls to `train(max_steps=100)` means
|
iterations. On the other hand, two calls to `train(max_steps=100)` means
|
||||||
|
Loading…
x
Reference in New Issue
Block a user