diff options
Diffstat (limited to 'tensorflow/g3doc/api_docs/python/functions_and_classes/shard6/tf.assert_negative.md')
-rw-r--r-- | tensorflow/g3doc/api_docs/python/functions_and_classes/shard6/tf.assert_negative.md | 33 |
1 files changed, 33 insertions, 0 deletions
diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard6/tf.assert_negative.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard6/tf.assert_negative.md new file mode 100644 index 0000000000..81daebec0d --- /dev/null +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard6/tf.assert_negative.md @@ -0,0 +1,33 @@ +### `tf.assert_negative(x, data=None, summarize=None, name=None)` {#assert_negative} + +Assert the condition `x < 0` holds element-wise. + +Example of adding a dependency to an operation: + +```python +with tf.control_dependencies([tf.assert_negative(x)]): + output = tf.reduce_sum(x) +``` + +Example of adding dependency to the tensor being checked: + +```python +x = tf.with_dependencies([tf.assert_negative(x)], x) +``` + +Negative means, for every element `x[i]` of `x`, we have `x[i] < 0`. +If `x` is empty this is trivially satisfied. + +##### Args: + + +* <b>`x`</b>: Numeric `Tensor`. +* <b>`data`</b>: The tensors to print out if the condition is False. Defaults to + error message and first few entries of `x`. +* <b>`summarize`</b>: Print this many entries of each tensor. +* <b>`name`</b>: A name for this operation (optional). Defaults to "assert_negative". + +##### Returns: + + Op raising `InvalidArgumentError` unless `x` is all negative. + |