diff options
author | 2016-05-03 12:50:29 -0800 | |
---|---|---|
committer | 2016-05-03 14:02:29 -0700 | |
commit | 7523801144c5fba4eb31748eae802a11758ff5c4 (patch) | |
tree | 709bd9d8811c1056da4a789d78b4b954a9ed76c8 | |
parent | 89d6d71cebfc5855719d0d0c6c572382b2fff855 (diff) |
Update generated Python Op docs.
Change: 121412172
-rw-r--r-- | tensorflow/g3doc/api_docs/python/index.md | 1 | ||||
-rw-r--r-- | tensorflow/g3doc/api_docs/python/state_ops.md | 30 | ||||
-rw-r--r-- | tensorflow/g3doc/api_docs/python/train.md | 20 |
3 files changed, 40 insertions, 11 deletions
diff --git a/tensorflow/g3doc/api_docs/python/index.md b/tensorflow/g3doc/api_docs/python/index.md index 584b39eb41..e7dfdda10e 100644 --- a/tensorflow/g3doc/api_docs/python/index.md +++ b/tensorflow/g3doc/api_docs/python/index.md @@ -91,6 +91,7 @@ * [`ones_initializer`](../../api_docs/python/state_ops.md#ones_initializer) * [`random_normal_initializer`](../../api_docs/python/state_ops.md#random_normal_initializer) * [`random_uniform_initializer`](../../api_docs/python/state_ops.md#random_uniform_initializer) + * [`report_uninitialized_variables`](../../api_docs/python/state_ops.md#report_uninitialized_variables) * [`Saver`](../../api_docs/python/state_ops.md#Saver) * [`scatter_add`](../../api_docs/python/state_ops.md#scatter_add) * [`scatter_sub`](../../api_docs/python/state_ops.md#scatter_sub) diff --git a/tensorflow/g3doc/api_docs/python/state_ops.md b/tensorflow/g3doc/api_docs/python/state_ops.md index 9d56f07065..b35de13783 100644 --- a/tensorflow/g3doc/api_docs/python/state_ops.md +++ b/tensorflow/g3doc/api_docs/python/state_ops.md @@ -596,7 +596,7 @@ This is just a shortcut for `initialize_variables(local_variables())` ### `tf.is_variable_initialized(variable)` {#is_variable_initialized} -Returns an Op to check if a variable has been initialized. +Tests if a variable has been initialized. ##### Args: @@ -605,7 +605,30 @@ Returns an Op to check if a variable has been initialized. ##### Returns: - An operation to check whether a variable has been initialized. + Returns a scalar boolean Tensor, `True` if the variable has been + initialized, `False` otherwise. + + +- - - + +### `tf.report_uninitialized_variables(var_list=None, name='report_uninitialized_variables')` {#report_uninitialized_variables} + +Adds ops to list the names of uninitialized variables. + +When run, it returns a 1-D tensor containing the names of uninitialized +variables if there are any, or an empty array if there are none. + +##### Args: + + +* <b>`var_list`</b>: List of `Variable` objects to check. Defaults to the + value of `all_variables() + local_variables()` +* <b>`name`</b>: Optional name of the `Operation`. + +##### Returns: + + A 1-D tensor containing names of the unintialized variables, or an empty 1-D + tensor if there are no variables or no uninitialized variables. - - - @@ -614,6 +637,9 @@ Returns an Op to check if a variable has been initialized. Returns an Op to check if variables are initialized. +NOTE: This function is obsolete and will be removed in 6 months. Please +change your implementation to use `report_uninitialized_variables()`. + When run, the returned Op will raise the exception `FailedPreconditionError` if any of the variables has not yet been initialized. diff --git a/tensorflow/g3doc/api_docs/python/train.md b/tensorflow/g3doc/api_docs/python/train.md index 5a8d6e254c..3a12b6ab17 100644 --- a/tensorflow/g3doc/api_docs/python/train.md +++ b/tensorflow/g3doc/api_docs/python/train.md @@ -1820,12 +1820,11 @@ Create a `Supervisor`. default `Graph`. The supervisor may add operations to the graph before creating a session, but the graph should not be modified by the caller after passing it to the supervisor. -* <b>`ready_op`</b>: `Operation` to check if the model is initialized. This - operation is run by supervisors in `prepare_or_wait_for_session()` to - check if the model is ready to use. The model is considered ready if - that operation succeeds. Defaults to the operation returned from - `tf.assert_variables_initialized()` If `None`, the model is not checked - for readiness. +* <b>`ready_op`</b>: 1-D string `Tensor`. This tensor is evaluated by supervisors in + `prepare_or_wait_for_session()` to check if the model is ready to use. + The model is considered ready if it returns an empty array. Defaults to + the tensor returned from `tf.report_uninitialized_variables()` If + `None`, the model is not checked for readiness. * <b>`is_chief`</b>: If True, create a chief supervisor in charge of initializing and restoring the model. If False, create a supervisor that relies on a chief supervisor for inits and restore. @@ -2539,9 +2538,12 @@ Creates a SessionManager. The `local_init_op` is an `Operation` that is run always after a new session was created. If `None`, this step is skipped. -The `ready_op` is an `Operation`. The model is considered ready -if that operation succeeds. If `None`, the model is not checked -for readiness. +The `ready_op` is an `Operation` used to check if the model is ready. The +model is considered ready if that operation returns an empty string tensor. +If the operation returns non empty string tensor, the elements are +concatenated and used to indicate to the user why the model is not ready. + +If `ready_op` is `None`, the model is not checked for readiness. `recovery_wait_secs` is the number of seconds between checks that the model is ready. It is used by processes to wait for a model to |