diff options
author | Jonathan Hseu <jhseu@google.com> | 2016-12-22 15:38:30 -0800 |
---|---|---|
committer | TensorFlower Gardener <gardener@tensorflow.org> | 2016-12-22 15:48:41 -0800 |
commit | bed8383c27a0a7225e6fc7ff59a2cd6388fb4d09 (patch) | |
tree | b70cfc88f95f318195f8610ffb960e98604348d1 /tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.audio_summary.md | |
parent | 1e5bd8cdd62033d1f7ea928fcbec521bb48bb1f5 (diff) |
Merge changes from github.
Change: 142805270
Diffstat (limited to 'tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.audio_summary.md')
-rw-r--r-- | tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.audio_summary.md | 37 |
1 files changed, 37 insertions, 0 deletions
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 new file mode 100644 index 0000000000..c5830ab550 --- /dev/null +++ b/tensorflow/g3doc/api_docs/python/functions_and_classes/shard9/tf.audio_summary.md @@ -0,0 +1,37 @@ +### `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. + |