aboutsummaryrefslogtreecommitdiffhomepage
path: root/tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.test.compute_gradient_error.md
diff options
context:
space:
mode:
Diffstat (limited to 'tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.test.compute_gradient_error.md')
-rw-r--r--tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.test.compute_gradient_error.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.test.compute_gradient_error.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.test.compute_gradient_error.md
new file mode 100644
index 0000000000..d2c91a66b3
--- /dev/null
+++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.test.compute_gradient_error.md
@@ -0,0 +1,36 @@
+### `tf.test.compute_gradient_error(x, x_shape, y, y_shape, x_init_value=None, delta=0.001, init_targets=None)` {#compute_gradient_error}
+
+Computes the gradient error.
+
+Computes the maximum error for dy/dx between the computed Jacobian and the
+numerically estimated Jacobian.
+
+This function will modify the tensors passed in as it adds more operations
+and hence changing the consumers of the operations of the input tensors.
+
+This function adds operations to the current session. To compute the error
+using a particular device, such as a GPU, use the standard methods for
+setting a device (e.g. using with sess.graph.device() or setting a device
+function in the session constructor).
+
+##### Args:
+
+
+* <b>`x`</b>: a tensor or list of tensors
+* <b>`x_shape`</b>: the dimensions of x as a tuple or an array of ints. If x is a list,
+ then this is the list of shapes.
+
+* <b>`y`</b>: a tensor
+* <b>`y_shape`</b>: the dimensions of y as a tuple or an array of ints.
+* <b>`x_init_value`</b>: (optional) a numpy array of the same shape as "x"
+ representing the initial value of x. If x is a list, this should be a list
+ of numpy arrays. If this is none, the function will pick a random tensor
+ as the initial value.
+* <b>`delta`</b>: (optional) the amount of perturbation.
+* <b>`init_targets`</b>: list of targets to run to initialize model params.
+ TODO(mrry): Remove this argument.
+
+##### Returns:
+
+ The maximum error in between the two Jacobians.
+