From b68903f5b6d29af34a251eb57b1dcb5bc2e38e5d Mon Sep 17 00:00:00 2001 From: "A. Unique TensorFlower" Date: Thu, 30 Jun 2016 19:37:05 -0800 Subject: [PATCH] Update generated Python Op docs. Change: 126374388 --- .../shard6/tf.train.Coordinator.md | 13 ++++++++++++- tensorflow/g3doc/api_docs/python/index.md | 1 + tensorflow/g3doc/api_docs/python/sparse_ops.md | 4 +++- tensorflow/g3doc/api_docs/python/train.md | 13 ++++++++++++- 4 files changed, 28 insertions(+), 3 deletions(-) diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard6/tf.train.Coordinator.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard6/tf.train.Coordinator.md index f51c0721ff0..bebc34754f4 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard6/tf.train.Coordinator.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard6/tf.train.Coordinator.md @@ -93,10 +93,21 @@ except Exception: ``` - - - -#### `tf.train.Coordinator.__init__()` {#Coordinator.__init__} +#### `tf.train.Coordinator.__init__(clean_stop_exception_types=None)` {#Coordinator.__init__} Create a new Coordinator. +##### Args: + + +* `clean_stop_exception_types`: Optional tuple of Exception types that should + cause a clean stop of the coordinator. If an exception of one of these + types is reported to `request_stop(ex)` the coordinator will behave as + if `request_stop(None)` was called. Defaults to + `(tf.errors.OutOfRangeError,)` which is used by input queues to signal + the end of input. When feeding training data from a Python iterator it + is common to add `StopIteration` to this list. + - - - diff --git a/tensorflow/g3doc/api_docs/python/index.md b/tensorflow/g3doc/api_docs/python/index.md index cabd2cee78d..53a971e694a 100644 --- a/tensorflow/g3doc/api_docs/python/index.md +++ b/tensorflow/g3doc/api_docs/python/index.md @@ -739,3 +739,4 @@ * [`copy_op_to_graph`](../../api_docs/python/contrib.copy_graph.md#copy_op_to_graph) * [`copy_variable_to_graph`](../../api_docs/python/contrib.copy_graph.md#copy_variable_to_graph) * [`get_copied_op`](../../api_docs/python/contrib.copy_graph.md#get_copied_op) + diff --git a/tensorflow/g3doc/api_docs/python/sparse_ops.md b/tensorflow/g3doc/api_docs/python/sparse_ops.md index 0444487fc7d..6781eadef41 100644 --- a/tensorflow/g3doc/api_docs/python/sparse_ops.md +++ b/tensorflow/g3doc/api_docs/python/sparse_ops.md @@ -764,7 +764,7 @@ For example: * `TypeError`: If `sp_input` is not a `SparseTensor`. * `ValueError`: If `new_shape` represents a tensor with a different rank from that of `sp_input` (if shapes are known when graph is constructed). -* `OpError`: +* `OpError`: - If `new_shape` has dimension sizes that are too small. - If shapes are not known during graph construction time, and during run time it is found out that the ranks do not match. @@ -1153,3 +1153,5 @@ B dense [k, n] A = A.H if adjoint_a else A B = B.H if adjoint_b else B return A*B + + diff --git a/tensorflow/g3doc/api_docs/python/train.md b/tensorflow/g3doc/api_docs/python/train.md index 64c8085c875..4f63fa0b7c1 100644 --- a/tensorflow/g3doc/api_docs/python/train.md +++ b/tensorflow/g3doc/api_docs/python/train.md @@ -1214,10 +1214,21 @@ except Exception: ``` - - - -#### `tf.train.Coordinator.__init__()` {#Coordinator.__init__} +#### `tf.train.Coordinator.__init__(clean_stop_exception_types=None)` {#Coordinator.__init__} Create a new Coordinator. +##### Args: + + +* `clean_stop_exception_types`: Optional tuple of Exception types that should + cause a clean stop of the coordinator. If an exception of one of these + types is reported to `request_stop(ex)` the coordinator will behave as + if `request_stop(None)` was called. Defaults to + `(tf.errors.OutOfRangeError,)` which is used by input queues to signal + the end of input. When feeding training data from a Python iterator it + is common to add `StopIteration` to this list. + - - -