aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorGravatar A. Unique TensorFlower <gardener@tensorflow.org>2016-11-10 16:43:26 -0800
committerGravatar TensorFlower Gardener <gardener@tensorflow.org>2016-11-10 17:02:17 -0800
commit5b5b6f55287b8d1a663d101e5dbf74fca2425891 (patch)
tree9edba41d6e14bae43b71320f4d54c64d603d43b3
parent2ea93a44d41628eb858fce8fafb68327bc54d018 (diff)
Update generated Python Op docs.
Change: 138822574
-rw-r--r--tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.merge_all_summaries.md23
-rw-r--r--tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.image_summary.md95
-rw-r--r--tensorflow/g3doc/api_docs/python/functions_and_classes/shard3/tf.scalar_summary.md31
-rw-r--r--tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.histogram_summary.md37
-rw-r--r--tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.merge_summary.md39
-rw-r--r--tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.audio_summary.md71
-rw-r--r--tensorflow/g3doc/api_docs/python/train.md260
7 files changed, 272 insertions, 284 deletions
diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.merge_all_summaries.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.merge_all_summaries.md
index bf17320a5a..40143de15d 100644
--- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.merge_all_summaries.md
+++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.merge_all_summaries.md
@@ -1,17 +1,16 @@
-### `tf.merge_all_summaries(*args, **kwargs)` {#merge_all_summaries}
+### `tf.merge_all_summaries(key='summaries')` {#merge_all_summaries}
-Merges all summaries collected in the default graph. (deprecated)
+Merges all summaries collected in the default graph.
-THIS FUNCTION IS DEPRECATED. It will be removed after 2016-11-30.
-Instructions for updating:
-Please switch to tf.summary.merge_all.
+##### Args:
- Args:
- key: `GraphKey` used to collect the summaries. Defaults to
- `GraphKeys.SUMMARIES`.
- Returns:
- If no summaries were collected, returns None. Otherwise returns a scalar
- `Tensor` of type `string` containing the serialized `Summary` protocol
- buffer resulting from the merging.
+* <b>`key`</b>: `GraphKey` used to collect the summaries. Defaults to
+ `GraphKeys.SUMMARIES`.
+
+##### Returns:
+
+ If no summaries were collected, returns None. Otherwise returns a scalar
+ `Tensor` of type `string` containing the serialized `Summary` protocol
+ buffer resulting from the merging.
diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.image_summary.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.image_summary.md
index 6220d3641b..5df729544b 100644
--- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.image_summary.md
+++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.image_summary.md
@@ -1,49 +1,48 @@
-### `tf.image_summary(*args, **kwargs)` {#image_summary}
-
-Outputs a `Summary` protocol buffer with images. (deprecated)
-
-THIS FUNCTION IS DEPRECATED. It will be removed after 2016-11-30.
-Instructions for updating:
-Please switch to tf.summary.image. Note that tf.summary.histogram uses the node name instead of the tag. This means that TensorFlow will automatically de-duplicate summary names based on the scope they are created in. Also, the max_images argument was renamed to max_outputs.
-
- The summary has up to `max_images` summary values containing images. The
- images are built from `tensor` which must be 4-D with shape `[batch_size,
- height, width, channels]` and where `channels` can be:
-
- * 1: `tensor` is interpreted as Grayscale.
- * 3: `tensor` is interpreted as RGB.
- * 4: `tensor` is interpreted as RGBA.
-
- The images have the same number of channels as the input tensor. For float
- input, the values are normalized one image at a time to fit in the range
- `[0, 255]`. `uint8` values are unchanged. The op uses two different
- normalization algorithms:
-
- * If the input values are all positive, they are rescaled so the largest one
- is 255.
-
- * If any input value is negative, the values are shifted so input value 0.0
- is at 127. They are then rescaled so that either the smallest value is 0,
- or the largest one is 255.
-
- The `tag` argument is a scalar `Tensor` of type `string`. It is used to
- build the `tag` of the summary values:
-
- * If `max_images` is 1, the summary value tag is '*tag*/image'.
- * If `max_images` is greater than 1, the summary value tags are
- generated sequentially as '*tag*/image/0', '*tag*/image/1', etc.
-
- Args:
- tag: A scalar `Tensor` of type `string`. Used to build the `tag`
- of the summary values.
- tensor: A 4-D `uint8` or `float32` `Tensor` of shape `[batch_size, height,
- width, channels]` where `channels` is 1, 3, or 4.
- max_images: Max number of batch elements to generate images for.
- collections: Optional list of ops.GraphKeys. The collections to add the
- summary to. Defaults to [ops.GraphKeys.SUMMARIES]
- name: A name for the operation (optional).
-
- Returns:
- A scalar `Tensor` of type `string`. The serialized `Summary` protocol
- buffer.
+### `tf.image_summary(tag, tensor, max_images=3, collections=None, name=None)` {#image_summary}
+
+Outputs a `Summary` protocol buffer with images.
+
+The summary has up to `max_images` summary values containing images. The
+images are built from `tensor` which must be 4-D with shape `[batch_size,
+height, width, channels]` and where `channels` can be:
+
+* 1: `tensor` is interpreted as Grayscale.
+* 3: `tensor` is interpreted as RGB.
+* 4: `tensor` is interpreted as RGBA.
+
+The images have the same number of channels as the input tensor. For float
+input, the values are normalized one image at a time to fit in the range
+`[0, 255]`. `uint8` values are unchanged. The op uses two different
+normalization algorithms:
+
+* If the input values are all positive, they are rescaled so the largest one
+ is 255.
+
+* If any input value is negative, the values are shifted so input value 0.0
+ is at 127. They are then rescaled so that either the smallest value is 0,
+ or the largest one is 255.
+
+The `tag` argument is a scalar `Tensor` of type `string`. It is used to
+build the `tag` of the summary values:
+
+* If `max_images` is 1, the summary value tag is '*tag*/image'.
+* If `max_images` is greater than 1, the summary value tags are
+ generated sequentially as '*tag*/image/0', '*tag*/image/1', etc.
+
+##### Args:
+
+
+* <b>`tag`</b>: A scalar `Tensor` of type `string`. Used to build the `tag`
+ of the summary values.
+* <b>`tensor`</b>: A 4-D `uint8` or `float32` `Tensor` of shape `[batch_size, height,
+ width, channels]` where `channels` is 1, 3, or 4.
+* <b>`max_images`</b>: Max number of batch elements to generate images for.
+* <b>`collections`</b>: Optional list of ops.GraphKeys. The collections to add the
+ summary to. Defaults to [ops.GraphKeys.SUMMARIES]
+* <b>`name`</b>: A name for the operation (optional).
+
+##### Returns:
+
+ A scalar `Tensor` of type `string`. The serialized `Summary` protocol
+ buffer.
diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard3/tf.scalar_summary.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard3/tf.scalar_summary.md
index f4080d6eb7..1e8c3479e4 100644
--- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard3/tf.scalar_summary.md
+++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard3/tf.scalar_summary.md
@@ -1,22 +1,21 @@
-### `tf.scalar_summary(*args, **kwargs)` {#scalar_summary}
+### `tf.scalar_summary(tags, values, collections=None, name=None)` {#scalar_summary}
-Outputs a `Summary` protocol buffer with scalar values. (deprecated)
+Outputs a `Summary` protocol buffer with scalar values.
-THIS FUNCTION IS DEPRECATED. It will be removed after 2016-11-30.
-Instructions for updating:
-Please switch to tf.summary.scalar. Note that tf.summary.histogram uses the node name instead of the tag. This means that TensorFlow will automatically de-duplicate summary names based on the scope they are created in. Also, passing a tensor or list of tags to a single scalar summary is no longer supported.
+The input `tags` and `values` must have the same shape. The generated
+summary has a summary value for each tag-value pair in `tags` and `values`.
- The input `tags` and `values` must have the same shape. The generated
- summary has a summary value for each tag-value pair in `tags` and `values`.
+##### Args:
- Args:
- tags: A `string` `Tensor`. Tags for the summaries.
- values: A real numeric Tensor. Values for the summaries.
- collections: Optional list of graph collections keys. The new summary op is
- added to these collections. Defaults to `[GraphKeys.SUMMARIES]`.
- name: A name for the operation (optional).
- Returns:
- A scalar `Tensor` of type `string`. The serialized `Summary` protocol
- buffer.
+* <b>`tags`</b>: A `string` `Tensor`. Tags for the summaries.
+* <b>`values`</b>: A real numeric Tensor. Values for the summaries.
+* <b>`collections`</b>: Optional list of graph collections keys. The new summary op is
+ added to these collections. Defaults to `[GraphKeys.SUMMARIES]`.
+* <b>`name`</b>: A name for the operation (optional).
+
+##### Returns:
+
+ A scalar `Tensor` of type `string`. The serialized `Summary` protocol
+ buffer.
diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.histogram_summary.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.histogram_summary.md
index 570d7b712c..1ede11e820 100644
--- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.histogram_summary.md
+++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.histogram_summary.md
@@ -1,26 +1,25 @@
-### `tf.histogram_summary(*args, **kwargs)` {#histogram_summary}
+### `tf.histogram_summary(tag, values, collections=None, name=None)` {#histogram_summary}
-Outputs a `Summary` protocol buffer with a histogram. (deprecated)
+Outputs a `Summary` protocol buffer with a histogram.
-THIS FUNCTION IS DEPRECATED. It will be removed after 2016-11-30.
-Instructions for updating:
-Please switch to tf.summary.histogram. Note that tf.summary.histogram uses the node name instead of the tag. This means that TensorFlow will automatically de-duplicate summary names based on their scope.
+The generated
+[`Summary`](https://www.tensorflow.org/code/tensorflow/core/framework/summary.proto)
+has one summary value containing a histogram for `values`.
- The generated
- [`Summary`](https://www.tensorflow.org/code/tensorflow/core/framework/summary.proto)
- has one summary value containing a histogram for `values`.
+This op reports an `InvalidArgument` error if any value is not finite.
- This op reports an `InvalidArgument` error if any value is not finite.
+##### Args:
- Args:
- tag: A `string` `Tensor`. 0-D. Tag to use for the summary value.
- values: A real numeric `Tensor`. Any shape. Values to use to
- build the histogram.
- collections: Optional list of graph collections keys. The new summary op is
- added to these collections. Defaults to `[GraphKeys.SUMMARIES]`.
- name: A name for the operation (optional).
- Returns:
- A scalar `Tensor` of type `string`. The serialized `Summary` protocol
- buffer.
+* <b>`tag`</b>: A `string` `Tensor`. 0-D. Tag to use for the summary value.
+* <b>`values`</b>: A real numeric `Tensor`. Any shape. Values to use to
+ build the histogram.
+* <b>`collections`</b>: Optional list of graph collections keys. The new summary op is
+ added to these collections. Defaults to `[GraphKeys.SUMMARIES]`.
+* <b>`name`</b>: A name for the operation (optional).
+
+##### Returns:
+
+ A scalar `Tensor` of type `string`. The serialized `Summary` protocol
+ buffer.
diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.merge_summary.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.merge_summary.md
index ccb984f5ab..b61a501c2d 100644
--- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.merge_summary.md
+++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.merge_summary.md
@@ -1,27 +1,26 @@
-### `tf.merge_summary(*args, **kwargs)` {#merge_summary}
+### `tf.merge_summary(inputs, collections=None, name=None)` {#merge_summary}
-Merges summaries. (deprecated)
+Merges summaries.
-THIS FUNCTION IS DEPRECATED. It will be removed after 2016-11-30.
-Instructions for updating:
-Please switch to tf.summary.merge.
+This op creates a
+[`Summary`](https://www.tensorflow.org/code/tensorflow/core/framework/summary.proto)
+protocol buffer that contains the union of all the values in the input
+summaries.
- This op creates a
- [`Summary`](https://www.tensorflow.org/code/tensorflow/core/framework/summary.proto)
- protocol buffer that contains the union of all the values in the input
- summaries.
+When the Op is run, it reports an `InvalidArgument` error if multiple values
+in the summaries to merge use the same tag.
- When the Op is run, it reports an `InvalidArgument` error if multiple values
- in the summaries to merge use the same tag.
+##### Args:
- Args:
- inputs: A list of `string` `Tensor` objects containing serialized `Summary`
- protocol buffers.
- collections: Optional list of graph collections keys. The new summary op is
- added to these collections. Defaults to `[GraphKeys.SUMMARIES]`.
- name: A name for the operation (optional).
- Returns:
- A scalar `Tensor` of type `string`. The serialized `Summary` protocol
- buffer resulting from the merging.
+* <b>`inputs`</b>: A list of `string` `Tensor` objects containing serialized `Summary`
+ protocol buffers.
+* <b>`collections`</b>: Optional list of graph collections keys. The new summary op is
+ added to these collections. Defaults to `[GraphKeys.SUMMARIES]`.
+* <b>`name`</b>: A name for the operation (optional).
+
+##### Returns:
+
+ A scalar `Tensor` of type `string`. The serialized `Summary` protocol
+ buffer resulting from the merging.
diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.audio_summary.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.audio_summary.md
index c5830ab550..c0aff77770 100644
--- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.audio_summary.md
+++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.audio_summary.md
@@ -1,37 +1,36 @@
-### `tf.audio_summary(*args, **kwargs)` {#audio_summary}
-
-Outputs a `Summary` protocol buffer with audio. (deprecated)
-
-THIS FUNCTION IS DEPRECATED. It will be removed after 2016-11-30.
-Instructions for updating:
-Please switch to tf.summary.audio. Note that tf.summary.histogram uses the node name instead of the tag. This means that TensorFlow will automatically de-duplicate summary names based on the scope they are created in.
-
- The summary has up to `max_outputs` summary values containing audio. The
- audio is built from `tensor` which must be 3-D with shape `[batch_size,
- frames, channels]` or 2-D with shape `[batch_size, frames]`. The values are
- assumed to be in the range of `[-1.0, 1.0]` with a sample rate of
- `sample_rate`.
-
- The `tag` argument is a scalar `Tensor` of type `string`. It is used to
- build the `tag` of the summary values:
-
- * If `max_outputs` is 1, the summary value tag is '*tag*/audio'.
- * If `max_outputs` is greater than 1, the summary value tags are
- generated sequentially as '*tag*/audio/0', '*tag*/audio/1', etc.
-
- Args:
- tag: A scalar `Tensor` of type `string`. Used to build the `tag`
- of the summary values.
- tensor: A 3-D `float32` `Tensor` of shape `[batch_size, frames, channels]`
- or a 2-D `float32` `Tensor` of shape `[batch_size, frames]`.
- sample_rate: A Scalar `float32` `Tensor` indicating the sample rate of the
- signal in hertz.
- max_outputs: Max number of batch elements to generate audio for.
- collections: Optional list of ops.GraphKeys. The collections to add the
- summary to. Defaults to [ops.GraphKeys.SUMMARIES]
- name: A name for the operation (optional).
-
- Returns:
- A scalar `Tensor` of type `string`. The serialized `Summary` protocol
- buffer.
+### `tf.audio_summary(tag, tensor, sample_rate, max_outputs=3, collections=None, name=None)` {#audio_summary}
+
+Outputs a `Summary` protocol buffer with audio.
+
+The summary has up to `max_outputs` summary values containing audio. The
+audio is built from `tensor` which must be 3-D with shape `[batch_size,
+frames, channels]` or 2-D with shape `[batch_size, frames]`. The values are
+assumed to be in the range of `[-1.0, 1.0]` with a sample rate of
+`sample_rate`.
+
+The `tag` argument is a scalar `Tensor` of type `string`. It is used to
+build the `tag` of the summary values:
+
+* If `max_outputs` is 1, the summary value tag is '*tag*/audio'.
+* If `max_outputs` is greater than 1, the summary value tags are
+ generated sequentially as '*tag*/audio/0', '*tag*/audio/1', etc.
+
+##### Args:
+
+
+* <b>`tag`</b>: A scalar `Tensor` of type `string`. Used to build the `tag`
+ of the summary values.
+* <b>`tensor`</b>: A 3-D `float32` `Tensor` of shape `[batch_size, frames, channels]`
+ or a 2-D `float32` `Tensor` of shape `[batch_size, frames]`.
+* <b>`sample_rate`</b>: A Scalar `float32` `Tensor` indicating the sample rate of the
+ signal in hertz.
+* <b>`max_outputs`</b>: Max number of batch elements to generate audio for.
+* <b>`collections`</b>: Optional list of ops.GraphKeys. The collections to add the
+ summary to. Defaults to [ops.GraphKeys.SUMMARIES]
+* <b>`name`</b>: A name for the operation (optional).
+
+##### Returns:
+
+ A scalar `Tensor` of type `string`. The serialized `Summary` protocol
+ buffer.
diff --git a/tensorflow/g3doc/api_docs/python/train.md b/tensorflow/g3doc/api_docs/python/train.md
index 1f69211e44..f82fea5c3e 100644
--- a/tensorflow/g3doc/api_docs/python/train.md
+++ b/tensorflow/g3doc/api_docs/python/train.md
@@ -3879,148 +3879,144 @@ details.
- - -
-### `tf.scalar_summary(*args, **kwargs)` {#scalar_summary}
+### `tf.scalar_summary(tags, values, collections=None, name=None)` {#scalar_summary}
-Outputs a `Summary` protocol buffer with scalar values. (deprecated)
+Outputs a `Summary` protocol buffer with scalar values.
-THIS FUNCTION IS DEPRECATED. It will be removed after 2016-11-30.
-Instructions for updating:
-Please switch to tf.summary.scalar. Note that tf.summary.histogram uses the node name instead of the tag. This means that TensorFlow will automatically de-duplicate summary names based on the scope they are created in. Also, passing a tensor or list of tags to a single scalar summary is no longer supported.
+The input `tags` and `values` must have the same shape. The generated
+summary has a summary value for each tag-value pair in `tags` and `values`.
- The input `tags` and `values` must have the same shape. The generated
- summary has a summary value for each tag-value pair in `tags` and `values`.
+##### Args:
+
+
+* <b>`tags`</b>: A `string` `Tensor`. Tags for the summaries.
+* <b>`values`</b>: A real numeric Tensor. Values for the summaries.
+* <b>`collections`</b>: Optional list of graph collections keys. The new summary op is
+ added to these collections. Defaults to `[GraphKeys.SUMMARIES]`.
+* <b>`name`</b>: A name for the operation (optional).
- Args:
- tags: A `string` `Tensor`. Tags for the summaries.
- values: A real numeric Tensor. Values for the summaries.
- collections: Optional list of graph collections keys. The new summary op is
- added to these collections. Defaults to `[GraphKeys.SUMMARIES]`.
- name: A name for the operation (optional).
+##### Returns:
- Returns:
- A scalar `Tensor` of type `string`. The serialized `Summary` protocol
- buffer.
+ A scalar `Tensor` of type `string`. The serialized `Summary` protocol
+ buffer.
- - -
-### `tf.image_summary(*args, **kwargs)` {#image_summary}
+### `tf.image_summary(tag, tensor, max_images=3, collections=None, name=None)` {#image_summary}
+
+Outputs a `Summary` protocol buffer with images.
-Outputs a `Summary` protocol buffer with images. (deprecated)
+The summary has up to `max_images` summary values containing images. The
+images are built from `tensor` which must be 4-D with shape `[batch_size,
+height, width, channels]` and where `channels` can be:
-THIS FUNCTION IS DEPRECATED. It will be removed after 2016-11-30.
-Instructions for updating:
-Please switch to tf.summary.image. Note that tf.summary.histogram uses the node name instead of the tag. This means that TensorFlow will automatically de-duplicate summary names based on the scope they are created in. Also, the max_images argument was renamed to max_outputs.
+* 1: `tensor` is interpreted as Grayscale.
+* 3: `tensor` is interpreted as RGB.
+* 4: `tensor` is interpreted as RGBA.
- The summary has up to `max_images` summary values containing images. The
- images are built from `tensor` which must be 4-D with shape `[batch_size,
- height, width, channels]` and where `channels` can be:
+The images have the same number of channels as the input tensor. For float
+input, the values are normalized one image at a time to fit in the range
+`[0, 255]`. `uint8` values are unchanged. The op uses two different
+normalization algorithms:
- * 1: `tensor` is interpreted as Grayscale.
- * 3: `tensor` is interpreted as RGB.
- * 4: `tensor` is interpreted as RGBA.
+* If the input values are all positive, they are rescaled so the largest one
+ is 255.
- The images have the same number of channels as the input tensor. For float
- input, the values are normalized one image at a time to fit in the range
- `[0, 255]`. `uint8` values are unchanged. The op uses two different
- normalization algorithms:
+* If any input value is negative, the values are shifted so input value 0.0
+ is at 127. They are then rescaled so that either the smallest value is 0,
+ or the largest one is 255.
- * If the input values are all positive, they are rescaled so the largest one
- is 255.
+The `tag` argument is a scalar `Tensor` of type `string`. It is used to
+build the `tag` of the summary values:
- * If any input value is negative, the values are shifted so input value 0.0
- is at 127. They are then rescaled so that either the smallest value is 0,
- or the largest one is 255.
+* If `max_images` is 1, the summary value tag is '*tag*/image'.
+* If `max_images` is greater than 1, the summary value tags are
+ generated sequentially as '*tag*/image/0', '*tag*/image/1', etc.
+
+##### Args:
- The `tag` argument is a scalar `Tensor` of type `string`. It is used to
- build the `tag` of the summary values:
- * If `max_images` is 1, the summary value tag is '*tag*/image'.
- * If `max_images` is greater than 1, the summary value tags are
- generated sequentially as '*tag*/image/0', '*tag*/image/1', etc.
+* <b>`tag`</b>: A scalar `Tensor` of type `string`. Used to build the `tag`
+ of the summary values.
+* <b>`tensor`</b>: A 4-D `uint8` or `float32` `Tensor` of shape `[batch_size, height,
+ width, channels]` where `channels` is 1, 3, or 4.
+* <b>`max_images`</b>: Max number of batch elements to generate images for.
+* <b>`collections`</b>: Optional list of ops.GraphKeys. The collections to add the
+ summary to. Defaults to [ops.GraphKeys.SUMMARIES]
+* <b>`name`</b>: A name for the operation (optional).
- Args:
- tag: A scalar `Tensor` of type `string`. Used to build the `tag`
- of the summary values.
- tensor: A 4-D `uint8` or `float32` `Tensor` of shape `[batch_size, height,
- width, channels]` where `channels` is 1, 3, or 4.
- max_images: Max number of batch elements to generate images for.
- collections: Optional list of ops.GraphKeys. The collections to add the
- summary to. Defaults to [ops.GraphKeys.SUMMARIES]
- name: A name for the operation (optional).
+##### Returns:
- Returns:
- A scalar `Tensor` of type `string`. The serialized `Summary` protocol
- buffer.
+ A scalar `Tensor` of type `string`. The serialized `Summary` protocol
+ buffer.
- - -
-### `tf.audio_summary(*args, **kwargs)` {#audio_summary}
+### `tf.audio_summary(tag, tensor, sample_rate, max_outputs=3, collections=None, name=None)` {#audio_summary}
+
+Outputs a `Summary` protocol buffer with audio.
+
+The summary has up to `max_outputs` summary values containing audio. The
+audio is built from `tensor` which must be 3-D with shape `[batch_size,
+frames, channels]` or 2-D with shape `[batch_size, frames]`. The values are
+assumed to be in the range of `[-1.0, 1.0]` with a sample rate of
+`sample_rate`.
-Outputs a `Summary` protocol buffer with audio. (deprecated)
+The `tag` argument is a scalar `Tensor` of type `string`. It is used to
+build the `tag` of the summary values:
-THIS FUNCTION IS DEPRECATED. It will be removed after 2016-11-30.
-Instructions for updating:
-Please switch to tf.summary.audio. Note that tf.summary.histogram uses the node name instead of the tag. This means that TensorFlow will automatically de-duplicate summary names based on the scope they are created in.
+* If `max_outputs` is 1, the summary value tag is '*tag*/audio'.
+* If `max_outputs` is greater than 1, the summary value tags are
+ generated sequentially as '*tag*/audio/0', '*tag*/audio/1', etc.
- The summary has up to `max_outputs` summary values containing audio. The
- audio is built from `tensor` which must be 3-D with shape `[batch_size,
- frames, channels]` or 2-D with shape `[batch_size, frames]`. The values are
- assumed to be in the range of `[-1.0, 1.0]` with a sample rate of
- `sample_rate`.
+##### Args:
- The `tag` argument is a scalar `Tensor` of type `string`. It is used to
- build the `tag` of the summary values:
- * If `max_outputs` is 1, the summary value tag is '*tag*/audio'.
- * If `max_outputs` is greater than 1, the summary value tags are
- generated sequentially as '*tag*/audio/0', '*tag*/audio/1', etc.
+* <b>`tag`</b>: A scalar `Tensor` of type `string`. Used to build the `tag`
+ of the summary values.
+* <b>`tensor`</b>: A 3-D `float32` `Tensor` of shape `[batch_size, frames, channels]`
+ or a 2-D `float32` `Tensor` of shape `[batch_size, frames]`.
+* <b>`sample_rate`</b>: A Scalar `float32` `Tensor` indicating the sample rate of the
+ signal in hertz.
+* <b>`max_outputs`</b>: Max number of batch elements to generate audio for.
+* <b>`collections`</b>: Optional list of ops.GraphKeys. The collections to add the
+ summary to. Defaults to [ops.GraphKeys.SUMMARIES]
+* <b>`name`</b>: A name for the operation (optional).
- Args:
- tag: A scalar `Tensor` of type `string`. Used to build the `tag`
- of the summary values.
- tensor: A 3-D `float32` `Tensor` of shape `[batch_size, frames, channels]`
- or a 2-D `float32` `Tensor` of shape `[batch_size, frames]`.
- sample_rate: A Scalar `float32` `Tensor` indicating the sample rate of the
- signal in hertz.
- max_outputs: Max number of batch elements to generate audio for.
- collections: Optional list of ops.GraphKeys. The collections to add the
- summary to. Defaults to [ops.GraphKeys.SUMMARIES]
- name: A name for the operation (optional).
+##### Returns:
- Returns:
- A scalar `Tensor` of type `string`. The serialized `Summary` protocol
- buffer.
+ A scalar `Tensor` of type `string`. The serialized `Summary` protocol
+ buffer.
- - -
-### `tf.histogram_summary(*args, **kwargs)` {#histogram_summary}
+### `tf.histogram_summary(tag, values, collections=None, name=None)` {#histogram_summary}
-Outputs a `Summary` protocol buffer with a histogram. (deprecated)
+Outputs a `Summary` protocol buffer with a histogram.
-THIS FUNCTION IS DEPRECATED. It will be removed after 2016-11-30.
-Instructions for updating:
-Please switch to tf.summary.histogram. Note that tf.summary.histogram uses the node name instead of the tag. This means that TensorFlow will automatically de-duplicate summary names based on their scope.
+The generated
+[`Summary`](https://www.tensorflow.org/code/tensorflow/core/framework/summary.proto)
+has one summary value containing a histogram for `values`.
- The generated
- [`Summary`](https://www.tensorflow.org/code/tensorflow/core/framework/summary.proto)
- has one summary value containing a histogram for `values`.
+This op reports an `InvalidArgument` error if any value is not finite.
- This op reports an `InvalidArgument` error if any value is not finite.
+##### Args:
+
+
+* <b>`tag`</b>: A `string` `Tensor`. 0-D. Tag to use for the summary value.
+* <b>`values`</b>: A real numeric `Tensor`. Any shape. Values to use to
+ build the histogram.
+* <b>`collections`</b>: Optional list of graph collections keys. The new summary op is
+ added to these collections. Defaults to `[GraphKeys.SUMMARIES]`.
+* <b>`name`</b>: A name for the operation (optional).
- Args:
- tag: A `string` `Tensor`. 0-D. Tag to use for the summary value.
- values: A real numeric `Tensor`. Any shape. Values to use to
- build the histogram.
- collections: Optional list of graph collections keys. The new summary op is
- added to these collections. Defaults to `[GraphKeys.SUMMARIES]`.
- name: A name for the operation (optional).
+##### Returns:
- Returns:
- A scalar `Tensor` of type `string`. The serialized `Summary` protocol
- buffer.
+ A scalar `Tensor` of type `string`. The serialized `Summary` protocol
+ buffer.
- - -
@@ -4052,52 +4048,50 @@ This is useful in summaries to measure and report sparsity. For example,
- - -
-### `tf.merge_summary(*args, **kwargs)` {#merge_summary}
+### `tf.merge_summary(inputs, collections=None, name=None)` {#merge_summary}
-Merges summaries. (deprecated)
+Merges summaries.
-THIS FUNCTION IS DEPRECATED. It will be removed after 2016-11-30.
-Instructions for updating:
-Please switch to tf.summary.merge.
+This op creates a
+[`Summary`](https://www.tensorflow.org/code/tensorflow/core/framework/summary.proto)
+protocol buffer that contains the union of all the values in the input
+summaries.
- This op creates a
- [`Summary`](https://www.tensorflow.org/code/tensorflow/core/framework/summary.proto)
- protocol buffer that contains the union of all the values in the input
- summaries.
+When the Op is run, it reports an `InvalidArgument` error if multiple values
+in the summaries to merge use the same tag.
- When the Op is run, it reports an `InvalidArgument` error if multiple values
- in the summaries to merge use the same tag.
+##### Args:
- Args:
- inputs: A list of `string` `Tensor` objects containing serialized `Summary`
- protocol buffers.
- collections: Optional list of graph collections keys. The new summary op is
- added to these collections. Defaults to `[GraphKeys.SUMMARIES]`.
- name: A name for the operation (optional).
- Returns:
- A scalar `Tensor` of type `string`. The serialized `Summary` protocol
- buffer resulting from the merging.
+* <b>`inputs`</b>: A list of `string` `Tensor` objects containing serialized `Summary`
+ protocol buffers.
+* <b>`collections`</b>: Optional list of graph collections keys. The new summary op is
+ added to these collections. Defaults to `[GraphKeys.SUMMARIES]`.
+* <b>`name`</b>: A name for the operation (optional).
+
+##### Returns:
+
+ A scalar `Tensor` of type `string`. The serialized `Summary` protocol
+ buffer resulting from the merging.
- - -
-### `tf.merge_all_summaries(*args, **kwargs)` {#merge_all_summaries}
+### `tf.merge_all_summaries(key='summaries')` {#merge_all_summaries}
-Merges all summaries collected in the default graph. (deprecated)
+Merges all summaries collected in the default graph.
-THIS FUNCTION IS DEPRECATED. It will be removed after 2016-11-30.
-Instructions for updating:
-Please switch to tf.summary.merge_all.
+##### Args:
- Args:
- key: `GraphKey` used to collect the summaries. Defaults to
- `GraphKeys.SUMMARIES`.
- Returns:
- If no summaries were collected, returns None. Otherwise returns a scalar
- `Tensor` of type `string` containing the serialized `Summary` protocol
- buffer resulting from the merging.
+* <b>`key`</b>: `GraphKey` used to collect the summaries. Defaults to
+ `GraphKeys.SUMMARIES`.
+
+##### Returns:
+
+ If no summaries were collected, returns None. Otherwise returns a scalar
+ `Tensor` of type `string` containing the serialized `Summary` protocol
+ buffer resulting from the merging.