From 83099f2bf116d9bf0cfb3d1384b3f612ffd3e8e5 Mon Sep 17 00:00:00 2001 From: "A. Unique TensorFlower" Date: Wed, 19 Oct 2016 12:56:16 -0800 Subject: [PATCH] Update generated Python Op docs. Change: 136637890 --- .../api_docs/python/contrib.distributions.md | 14 +- .../shard0/tf.summary.merge_all.md | 16 ++ ...b.distributions.TransformedDistribution.md | 14 +- .../shard2/tf.summary.audio.md | 35 ++++ .../shard5/tf.summary.image.md | 47 +++++ .../shard8/tf.summary.histogram.md | 25 +++ .../shard8/tf.summary.merge.md | 26 +++ tensorflow/g3doc/api_docs/python/index.md | 5 + tensorflow/g3doc/api_docs/python/summary.md | 164 ++++++++++++++++++ 9 files changed, 332 insertions(+), 14 deletions(-) create mode 100644 tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.summary.merge_all.md create mode 100644 tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.summary.audio.md create mode 100644 tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.summary.image.md create mode 100644 tensorflow/g3doc/api_docs/python/functions_and_classes/shard8/tf.summary.histogram.md create mode 100644 tensorflow/g3doc/api_docs/python/functions_and_classes/shard8/tf.summary.merge.md diff --git a/tensorflow/g3doc/api_docs/python/contrib.distributions.md b/tensorflow/g3doc/api_docs/python/contrib.distributions.md index f0e5da3d982..34ae9e2d941 100644 --- a/tensorflow/g3doc/api_docs/python/contrib.distributions.md +++ b/tensorflow/g3doc/api_docs/python/contrib.distributions.md @@ -20217,8 +20217,8 @@ Additional documentation from `TransformedDistribution`: ##### `condition_kwargs`: -* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. * `bijector_kwargs`: Python dictionary of arg names/values forwarded to the bijector. +* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. ##### Args: @@ -20335,8 +20335,8 @@ Additional documentation from `TransformedDistribution`: ##### `condition_kwargs`: -* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. * `bijector_kwargs`: Python dictionary of arg names/values forwarded to the bijector. +* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. ##### Args: @@ -20419,8 +20419,8 @@ Implements `(log o p o g^{-1})(y) + (log o det o J o g^{-1})(y)`, ##### `condition_kwargs`: -* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. * `bijector_kwargs`: Python dictionary of arg names/values forwarded to the bijector. +* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. ##### Args: @@ -20458,8 +20458,8 @@ Additional documentation from `TransformedDistribution`: ##### `condition_kwargs`: -* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. * `bijector_kwargs`: Python dictionary of arg names/values forwarded to the bijector. +* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. ##### Args: @@ -20611,8 +20611,8 @@ Implements `p(g^{-1}(y)) det|J(g^{-1}(y))|`, where `g^{-1}` is the ##### `condition_kwargs`: -* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. * `bijector_kwargs`: Python dictionary of arg names/values forwarded to the bijector. +* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. ##### Args: @@ -20665,8 +20665,8 @@ Samples from the base distribution and then passes through ##### `condition_kwargs`: -* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. * `bijector_kwargs`: Python dictionary of arg names/values forwarded to the bijector. +* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. ##### Args: @@ -20714,8 +20714,8 @@ Additional documentation from `TransformedDistribution`: ##### `condition_kwargs`: -* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. * `bijector_kwargs`: Python dictionary of arg names/values forwarded to the bijector. +* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. ##### Args: diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.summary.merge_all.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.summary.merge_all.md new file mode 100644 index 00000000000..8f1ff2a277f --- /dev/null +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard0/tf.summary.merge_all.md @@ -0,0 +1,16 @@ +### `tf.summary.merge_all(key='summaries')` {#merge_all} + +Merges all summaries collected in the default graph. + +##### 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. + diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.contrib.distributions.TransformedDistribution.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.contrib.distributions.TransformedDistribution.md index fc76841477a..25a8707b38a 100644 --- a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.contrib.distributions.TransformedDistribution.md +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard1/tf.contrib.distributions.TransformedDistribution.md @@ -182,8 +182,8 @@ Additional documentation from `TransformedDistribution`: ##### `condition_kwargs`: -* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. * `bijector_kwargs`: Python dictionary of arg names/values forwarded to the bijector. +* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. ##### Args: @@ -300,8 +300,8 @@ Additional documentation from `TransformedDistribution`: ##### `condition_kwargs`: -* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. * `bijector_kwargs`: Python dictionary of arg names/values forwarded to the bijector. +* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. ##### Args: @@ -384,8 +384,8 @@ Implements `(log o p o g^{-1})(y) + (log o det o J o g^{-1})(y)`, ##### `condition_kwargs`: -* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. * `bijector_kwargs`: Python dictionary of arg names/values forwarded to the bijector. +* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. ##### Args: @@ -423,8 +423,8 @@ Additional documentation from `TransformedDistribution`: ##### `condition_kwargs`: -* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. * `bijector_kwargs`: Python dictionary of arg names/values forwarded to the bijector. +* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. ##### Args: @@ -576,8 +576,8 @@ Implements `p(g^{-1}(y)) det|J(g^{-1}(y))|`, where `g^{-1}` is the ##### `condition_kwargs`: -* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. * `bijector_kwargs`: Python dictionary of arg names/values forwarded to the bijector. +* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. ##### Args: @@ -630,8 +630,8 @@ Samples from the base distribution and then passes through ##### `condition_kwargs`: -* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. * `bijector_kwargs`: Python dictionary of arg names/values forwarded to the bijector. +* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. ##### Args: @@ -679,8 +679,8 @@ Additional documentation from `TransformedDistribution`: ##### `condition_kwargs`: -* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. * `bijector_kwargs`: Python dictionary of arg names/values forwarded to the bijector. +* `distribution_kwargs`: Python dictionary of arg names/values forwarded to the distribution. ##### Args: diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.summary.audio.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.summary.audio.md new file mode 100644 index 00000000000..c7edb742910 --- /dev/null +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard2/tf.summary.audio.md @@ -0,0 +1,35 @@ +### `tf.summary.audio(name, tensor, sample_rate, max_outputs=3, collections=None)` {#audio} + +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` in the outputted Summary.Value protobufs is generated based on the +name, with a suffix depending on the max_outputs setting: + +* If `max_outputs` is 1, the summary value tag is '*name*/audio'. +* If `max_outputs` is greater than 1, the summary value tags are + generated sequentially as '*name*/audio/0', '*name*/audio/1', etc + +##### Args: + + +* `name`: A name for the generated node. Will also serve as a series name in + TensorBoard. +* `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] + +##### 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.summary.image.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.summary.image.md new file mode 100644 index 00000000000..c60608a83c1 --- /dev/null +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard5/tf.summary.image.md @@ -0,0 +1,47 @@ +### `tf.summary.image(name, tensor, max_outputs=3, collections=None)` {#image} + +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` in the outputted Summary.Value protobufs is generated based on the +name, with a suffix depending on the max_outputs setting: + +* If `max_outputs` is 1, the summary value tag is '*name*/image'. +* If `max_outputs` is greater than 1, the summary value tags are + generated sequentially as '*name*/image/0', '*name*/image/1', etc. + +##### Args: + + +* `name`: A name for the generated node. Will also serve as a series name in + TensorBoard. +* `tensor`: A 4-D `uint8` or `float32` `Tensor` of shape `[batch_size, height, + width, channels]` where `channels` is 1, 3, or 4. +* `max_outputs`: 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] + +##### Returns: + + A scalar `Tensor` of type `string`. The serialized `Summary` protocol + buffer. + diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard8/tf.summary.histogram.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard8/tf.summary.histogram.md new file mode 100644 index 00000000000..19df48fd3f4 --- /dev/null +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard8/tf.summary.histogram.md @@ -0,0 +1,25 @@ +### `tf.summary.histogram(name, values, collections=None)` {#histogram} + +Outputs a `Summary` protocol buffer with a histogram. + +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. + +##### Args: + + +* `name`: A name for the generated node. Will also serve as a series name in + TensorBoard. +* `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]`. + +##### Returns: + + A scalar `Tensor` of type `string`. The serialized `Summary` protocol + buffer. + diff --git a/tensorflow/g3doc/api_docs/python/functions_and_classes/shard8/tf.summary.merge.md b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard8/tf.summary.merge.md new file mode 100644 index 00000000000..17ecbd0654d --- /dev/null +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard8/tf.summary.merge.md @@ -0,0 +1,26 @@ +### `tf.summary.merge(inputs, collections=None, name=None)` {#merge} + +Merges 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. + +##### 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. + diff --git a/tensorflow/g3doc/api_docs/python/index.md b/tensorflow/g3doc/api_docs/python/index.md index 563347a05ce..d649acbcb45 100644 --- a/tensorflow/g3doc/api_docs/python/index.md +++ b/tensorflow/g3doc/api_docs/python/index.md @@ -629,7 +629,12 @@ * [`py_func`](../../api_docs/python/script_ops.md#py_func) * **[Summary Operations](../../api_docs/python/summary.md)**: + * [`audio`](../../api_docs/python/summary.md#audio) * [`get_summary_description`](../../api_docs/python/summary.md#get_summary_description) + * [`histogram`](../../api_docs/python/summary.md#histogram) + * [`image`](../../api_docs/python/summary.md#image) + * [`merge`](../../api_docs/python/summary.md#merge) + * [`merge_all`](../../api_docs/python/summary.md#merge_all) * [`scalar`](../../api_docs/python/summary.md#scalar) * [`tensor_summary`](../../api_docs/python/summary.md#tensor_summary) diff --git a/tensorflow/g3doc/api_docs/python/summary.md b/tensorflow/g3doc/api_docs/python/summary.md index 530e4e2cd7c..0d35fde46eb 100644 --- a/tensorflow/g3doc/api_docs/python/summary.md +++ b/tensorflow/g3doc/api_docs/python/summary.md @@ -60,6 +60,170 @@ The generated Summary has a Tensor.proto containing the input Tensor. * `ValueError`: If tensor has the wrong shape or type. +- - - + +### `tf.summary.histogram(name, values, collections=None)` {#histogram} + +Outputs a `Summary` protocol buffer with a histogram. + +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. + +##### Args: + + +* `name`: A name for the generated node. Will also serve as a series name in + TensorBoard. +* `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]`. + +##### Returns: + + A scalar `Tensor` of type `string`. The serialized `Summary` protocol + buffer. + + +- - - + +### `tf.summary.audio(name, tensor, sample_rate, max_outputs=3, collections=None)` {#audio} + +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` in the outputted Summary.Value protobufs is generated based on the +name, with a suffix depending on the max_outputs setting: + +* If `max_outputs` is 1, the summary value tag is '*name*/audio'. +* If `max_outputs` is greater than 1, the summary value tags are + generated sequentially as '*name*/audio/0', '*name*/audio/1', etc + +##### Args: + + +* `name`: A name for the generated node. Will also serve as a series name in + TensorBoard. +* `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] + +##### Returns: + + A scalar `Tensor` of type `string`. The serialized `Summary` protocol + buffer. + + +- - - + +### `tf.summary.image(name, tensor, max_outputs=3, collections=None)` {#image} + +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` in the outputted Summary.Value protobufs is generated based on the +name, with a suffix depending on the max_outputs setting: + +* If `max_outputs` is 1, the summary value tag is '*name*/image'. +* If `max_outputs` is greater than 1, the summary value tags are + generated sequentially as '*name*/image/0', '*name*/image/1', etc. + +##### Args: + + +* `name`: A name for the generated node. Will also serve as a series name in + TensorBoard. +* `tensor`: A 4-D `uint8` or `float32` `Tensor` of shape `[batch_size, height, + width, channels]` where `channels` is 1, 3, or 4. +* `max_outputs`: 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] + +##### Returns: + + A scalar `Tensor` of type `string`. The serialized `Summary` protocol + buffer. + + +- - - + +### `tf.summary.merge(inputs, collections=None, name=None)` {#merge} + +Merges 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. + +##### 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. + + +- - - + +### `tf.summary.merge_all(key='summaries')` {#merge_all} + +Merges all summaries collected in the default graph. + +##### 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. + + ## Utilities - - - -- GitLab