Add a warning to documentation of MonitoredSession.

PiperOrigin-RevId: 157728225
This commit is contained in:
Mustafa Ispir 2017-06-01 10:13:32 -07:00 committed by TensorFlower Gardener
parent eb10a4c494
commit f60b6bdcb5

View File

@ -279,7 +279,8 @@ def MonitoredTrainingSession(master='', # pylint: disable=invalid-name
For a chief, this utility sets proper session initializer/restorer. It also
creates hooks related to checkpoint and summary saving. For workers, this
utility sets proper session creator which waits for the chief to
initialize/restore.
initialize/restore. Please check `tf.train.MonitoredSession` for more
information.
Args:
@ -633,6 +634,12 @@ class MonitoredSession(_MonitoredSession):
See `MonitoredTrainingSession` for an example usage based on chief or worker.
Note: This is not a `tf.Session`. For example, it cannot do following:
* it cannot be set as default session.
* it cannot be sent to saver.save.
* it cannot be sent to tf.train.start_queue_runners.
Args:
session_creator: A factory object to create session. Typically a
`ChiefSessionCreator` which is the default one.