aboutsummaryrefslogtreecommitdiffhomepage
path: root/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.assert_equal.md
diff options
context:
space:
mode:
Diffstat (limited to 'tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.assert_equal.md')
-rw-r--r--tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.assert_equal.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.assert_equal.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.assert_equal.md
new file mode 100644
index 0000000000..ea4fd3a1fd
--- /dev/null
+++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.assert_equal.md
@@ -0,0 +1,35 @@
+### `tf.assert_equal(x, y, data=None, summarize=None, name=None)` {#assert_equal}
+
+Assert the condition `x == y` holds element-wise.
+
+Example of adding a dependency to an operation:
+
+```python
+with tf.control_dependencies([tf.assert_equal(x, y)]):
+ output = tf.reduce_sum(x)
+```
+
+Example of adding dependency to the tensor being checked:
+
+```python
+x = tf.with_dependencies([tf.assert_equal(x, y)], x)
+```
+
+This condition holds if for every pair of (possibly broadcast) elements
+`x[i]`, `y[i]`, we have `x[i] == y[i]`.
+If both `x` and `y` are empty, this is trivially satisfied.
+
+##### Args:
+
+
+* <b>`x`</b>: Numeric `Tensor`.
+* <b>`y`</b>: Numeric `Tensor`, same dtype as and broadcastable to `x`.
+* <b>`data`</b>: The tensors to print out if the condition is False. Defaults to
+ error message and first few entries of `x`, `y`.
+* <b>`summarize`</b>: Print this many entries of each tensor.
+* <b>`name`</b>: A name for this operation (optional). Defaults to "assert_equal".
+
+##### Returns:
+
+ Op that raises `InvalidArgumentError` if `x == y` is False.
+