aboutsummaryrefslogtreecommitdiffhomepage
path: root/tensorflow/g3doc/api_docs/python/functions_and_classes/shard7/tf.clip_by_average_norm.md
diff options
context:
space:
mode:
Diffstat (limited to 'tensorflow/g3doc/api_docs/python/functions_and_classes/shard7/tf.clip_by_average_norm.md')
-rw-r--r--tensorflow/g3doc/api_docs/python/functions_and_classes/shard7/tf.clip_by_average_norm.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard7/tf.clip_by_average_norm.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard7/tf.clip_by_average_norm.md
new file mode 100644
index 0000000000..4598e183d8
--- /dev/null
+++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard7/tf.clip_by_average_norm.md
@@ -0,0 +1,29 @@
+### `tf.clip_by_average_norm(t, clip_norm, name=None)` {#clip_by_average_norm}
+
+Clips tensor values to a maximum average L2-norm.
+
+Given a tensor `t`, and a maximum clip value `clip_norm`, this operation
+normalizes `t` so that its average L2-norm is less than or equal to
+`clip_norm`. Specifically, if the average L2-norm is already less than or
+equal to `clip_norm`, then `t` is not modified. If the average L2-norm is
+greater than `clip_norm`, then this operation returns a tensor of the same
+type and shape as `t` with its values set to:
+
+`t * clip_norm / l2norm_avg(t)`
+
+In this case, the average L2-norm of the output tensor is `clip_norm`.
+
+This operation is typically used to clip gradients before applying them with
+an optimizer.
+
+##### Args:
+
+
+* <b>`t`</b>: A `Tensor`.
+* <b>`clip_norm`</b>: A 0-D (scalar) `Tensor` > 0. A maximum clipping value.
+* <b>`name`</b>: A name for the operation (optional).
+
+##### Returns:
+
+ A clipped `Tensor`.
+