diff options
author | A. Unique TensorFlower <gardener@tensorflow.org> | 2016-11-10 17:27:15 -0800 |
---|---|---|
committer | TensorFlower Gardener <gardener@tensorflow.org> | 2016-11-10 17:43:44 -0800 |
commit | cd0442a7182e7b003ce1bc769eef70e14b97d860 (patch) | |
tree | dce763ecb6227428e98eec32d596af385863d3a5 | |
parent | 006dddc65b6c50da08382e2c590aa7d099481ddd (diff) |
Update generated Python Op docs.
Change: 138826873
5 files changed, 110 insertions, 2 deletions
diff --git a/tensorflow/g3doc/api_docs/python/array_ops.md b/tensorflow/g3doc/api_docs/python/array_ops.md index 526aa1ad4e..f5f1ccfd6d 100644 --- a/tensorflow/g3doc/api_docs/python/array_ops.md +++ b/tensorflow/g3doc/api_docs/python/array_ops.md @@ -756,6 +756,59 @@ tf.unpack(t, axis=axis) - - - +### `tf.split_v(value, size_splits, split_dim=0, num=None, name='split_v')` {#split_v} + +Splits a tensor into sub tensors. + +If size_splits is a scalar, `num_split`, then +splits `value` along dimension `split_dim` into `num_split` smaller tensors. +Requires that `num_split` evenly divide `value.shape[split_dim]`. + +If size_splits is a tensor, then +splits `value` into len(size_splits) pieces each the same size as the input +except along dimension split_dim where the size is size_splits[i]. + +For example: + +```python +# 'value' is a tensor with shape [5, 30] +# Split 'value' into 3 tensors with sizes [4, 15, 11] along dimension 1 +split0, split1, split2 = tf.split_v(1, [4, 15, 11], value) +tf.shape(split0) ==> [5, 4] +tf.shape(split1) ==> [5, 15] +tf.shape(split2) ==> [5, 11] +# Split 'value' into 3 tensors along dimension 1 +split0, split1, split2 = tf.split(value, 3, 1) +tf.shape(split0) ==> [5, 10] +``` + +##### Args: + + +* <b>`value`</b>: The `Tensor` to split. +* <b>`size_splits`</b>: Either an integer indicating the number of splits along + split_dim or a 1-D Tensor containing the sizes of each output tensor + along split_dim. If an integer then it must evenly divide + value.shape[split_dim]; otherwise the sum of sizes along the split + dimension must match that of the input. +* <b>`split_dim`</b>: A 0-D `int32` `Tensor`. The dimension along which to split. + Must be in the range `[0, rank(value))`. Defaults to 0. +* <b>`num`</b>: Optional, used to specify the number of outputs when it cannot be + inferred from the shape of size_splits. +* <b>`name`</b>: A name for the operation (optional). + +##### Returns: + + `len(size_splits)` `Tensor` objects resulting from splitting `value`. + +##### Raises: + + +* <b>`ValueError`</b>: If `num` is unspecified and cannot be inferred. + + +- - - + ### `tf.tile(input, multiples, name=None)` {#tile} Constructs a tensor by tiling a given tensor. diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.split_v.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.split_v.md new file mode 100644 index 0000000000..7e27ca6ac4 --- /dev/null +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.split_v.md @@ -0,0 +1,50 @@ +### `tf.split_v(value, size_splits, split_dim=0, num=None, name='split_v')` {#split_v} + +Splits a tensor into sub tensors. + +If size_splits is a scalar, `num_split`, then +splits `value` along dimension `split_dim` into `num_split` smaller tensors. +Requires that `num_split` evenly divide `value.shape[split_dim]`. + +If size_splits is a tensor, then +splits `value` into len(size_splits) pieces each the same size as the input +except along dimension split_dim where the size is size_splits[i]. + +For example: + +```python +# 'value' is a tensor with shape [5, 30] +# Split 'value' into 3 tensors with sizes [4, 15, 11] along dimension 1 +split0, split1, split2 = tf.split_v(1, [4, 15, 11], value) +tf.shape(split0) ==> [5, 4] +tf.shape(split1) ==> [5, 15] +tf.shape(split2) ==> [5, 11] +# Split 'value' into 3 tensors along dimension 1 +split0, split1, split2 = tf.split(value, 3, 1) +tf.shape(split0) ==> [5, 10] +``` + +##### Args: + + +* <b>`value`</b>: The `Tensor` to split. +* <b>`size_splits`</b>: Either an integer indicating the number of splits along + split_dim or a 1-D Tensor containing the sizes of each output tensor + along split_dim. If an integer then it must evenly divide + value.shape[split_dim]; otherwise the sum of sizes along the split + dimension must match that of the input. +* <b>`split_dim`</b>: A 0-D `int32` `Tensor`. The dimension along which to split. + Must be in the range `[0, rank(value))`. Defaults to 0. +* <b>`num`</b>: Optional, used to specify the number of outputs when it cannot be + inferred from the shape of size_splits. +* <b>`name`</b>: A name for the operation (optional). + +##### Returns: + + `len(size_splits)` `Tensor` objects resulting from splitting `value`. + +##### Raises: + + +* <b>`ValueError`</b>: If `num` is unspecified and cannot be inferred. + diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.test.Benchmark.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.test.Benchmark.md index e461b5d541..a8770277ac 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.test.Benchmark.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.test.Benchmark.md @@ -27,7 +27,7 @@ Report a benchmark. - - - -#### `tf.test.Benchmark.run_op_benchmark(sess, op_or_tensor, feed_dict=None, burn_iters=2, min_iters=10, store_trace=False, name=None, extras=None)` {#Benchmark.run_op_benchmark} +#### `tf.test.Benchmark.run_op_benchmark(sess, op_or_tensor, feed_dict=None, burn_iters=2, min_iters=10, store_trace=False, name=None, extras=None, mbs=0)` {#Benchmark.run_op_benchmark} Run an op or tensor in the given session. Report the results. @@ -48,6 +48,8 @@ Run an op or tensor in the given session. Report the results. Otherwise it is inferred from the top-level method name. * <b>`extras`</b>: (optional) Dict mapping string keys to additional benchmark info. Values may be either floats or values that are convertible to strings. +* <b>`mbs`</b>: (optional) The number of megabytes moved by this op, used to + calculate the ops throughput. ##### Returns: diff --git a/tensorflow/g3doc/api_docs/python/index.md b/tensorflow/g3doc/api_docs/python/index.md index 136a0d506f..5f7dd9dd2f 100644 --- a/tensorflow/g3doc/api_docs/python/index.md +++ b/tensorflow/g3doc/api_docs/python/index.md @@ -174,6 +174,7 @@ * [`space_to_batch_nd`](../../api_docs/python/array_ops.md#space_to_batch_nd) * [`space_to_depth`](../../api_docs/python/array_ops.md#space_to_depth) * [`split`](../../api_docs/python/array_ops.md#split) + * [`split_v`](../../api_docs/python/array_ops.md#split_v) * [`squeeze`](../../api_docs/python/array_ops.md#squeeze) * [`stack`](../../api_docs/python/array_ops.md#stack) * [`strided_slice`](../../api_docs/python/array_ops.md#strided_slice) diff --git a/tensorflow/g3doc/api_docs/python/test.md b/tensorflow/g3doc/api_docs/python/test.md index a7a65558da..ff0f7b0b69 100644 --- a/tensorflow/g3doc/api_docs/python/test.md +++ b/tensorflow/g3doc/api_docs/python/test.md @@ -1590,7 +1590,7 @@ Report a benchmark. - - - -#### `tf.test.Benchmark.run_op_benchmark(sess, op_or_tensor, feed_dict=None, burn_iters=2, min_iters=10, store_trace=False, name=None, extras=None)` {#Benchmark.run_op_benchmark} +#### `tf.test.Benchmark.run_op_benchmark(sess, op_or_tensor, feed_dict=None, burn_iters=2, min_iters=10, store_trace=False, name=None, extras=None, mbs=0)` {#Benchmark.run_op_benchmark} Run an op or tensor in the given session. Report the results. @@ -1611,6 +1611,8 @@ Run an op or tensor in the given session. Report the results. Otherwise it is inferred from the top-level method name. * <b>`extras`</b>: (optional) Dict mapping string keys to additional benchmark info. Values may be either floats or values that are convertible to strings. +* <b>`mbs`</b>: (optional) The number of megabytes moved by this op, used to + calculate the ops throughput. ##### Returns: |