Input for this argument now must be
three-dimensional [k, t, c], where
k is the number of audio clips, t
is the number of frames, and c is
the number of channels. Two-dimensional
input is no longer supported.
Please use tf.name_scope instead to
manage summary name prefix.
-
encoding
Optional constant str for the desired
encoding. Check the docs for
tf.summary.audio for latest supported
audio formats.
-
description
Optional long-form str description
for the summary. Markdown is supported.
Defaults to empty.
Description
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 float32Tensor of shape [batch_size, frames, channels]
or a 2-D float32Tensor of shape [batch_size, frames].
sample_rate
A Scalar float32Tensor 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]
family
Optional; if provided, used as the prefix of the summary tag name,
which controls the tab name used for display on Tensorboard.
Returns
A scalar Tensor of type string. The serialized Summary protocol
buffer.
[null,null,["Last updated 2023-03-17 UTC."],[],[],null,["# tf.compat.v1.summary.audio\n\n\u003cbr /\u003e\n\n|------------------------------------------------------------------------------------------------------------------------------|\n| [View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v2.8.4/tensorflow/python/summary/summary.py#L260-L342) |\n\nOutputs a `Summary` protocol buffer with audio. \n\n tf.compat.v1.summary.audio(\n name, tensor, sample_rate, max_outputs=3, collections=None, family=None\n )\n\n\u003cbr /\u003e\n\nMigrate to TF2\n--------------\n\n\u003cbr /\u003e\n\n| **Caution:** This API was designed for TensorFlow v1. Continue reading for details on how to migrate from this API to a native TensorFlow v2 equivalent. See the [TensorFlow v1 to TensorFlow v2 migration guide](https://www.tensorflow.org/guide/migrate) for instructions on how to migrate the rest of your code.\n\nThis API is not compatible with eager execution or [`tf.function`](../../../../tf/function). To migrate\nto TF2, please use [`tf.summary.audio`](../../../../tf/summary/audio) instead. Please check\n[Migrating tf.summary usage to\nTF 2.0](https://www.tensorflow.org/tensorboard/migrate#in_tf_1x) for concrete\nsteps for migration.\n\n#### How to Map Arguments\n\n| TF1 Arg Name | TF2 Arg Name | Note |\n|---------------|---------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `name` | - |\n| `tensor` | `data` | Input for this argument now must be three-dimensional `[k, t, c]`, where `k` is the number of audio clips, `t` is the number of frames, and `c` is the number of channels. Two-dimensional input is no longer supported. |\n| `sample_rate` | `sample_rate` | - |\n| - | `step` | Explicit int64-castable monotonic step value. If omitted, this defaults to [`tf.summary.experimental.get_step()`](../../../../tf/summary/experimental/get_step). |\n| `max_outputs` | `max_outputs` | - |\n| `collections` | Not Supported | - |\n| `family` | Removed | Please use [`tf.name_scope`](../../../../tf/name_scope) instead to manage summary name prefix. |\n| - | `encoding` | Optional constant str for the desired encoding. Check the docs for [`tf.summary.audio`](../../../../tf/summary/audio) for latest supported audio formats. |\n| - | `description` | Optional long-form `str` description for the summary. Markdown is supported. Defaults to empty. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\nDescription\n-----------\n\nThe summary has up to `max_outputs` summary values containing audio. The\naudio is built from `tensor` which must be 3-D with shape `[batch_size,\nframes, channels]` or 2-D with shape `[batch_size, frames]`. The values are\nassumed to be in the range of `[-1.0, 1.0]` with a sample rate of\n`sample_rate`.\n\nThe `tag` in the outputted Summary.Value protobufs is generated based on the\nname, with a suffix depending on the max_outputs setting:\n\n- If `max_outputs` is 1, the summary value tag is '*name*/audio'.\n- If `max_outputs` is greater than 1, the summary value tags are generated sequentially as '*name* /audio/0', '*name*/audio/1', etc\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Args ---- ||\n|---------------|---------------------------------------------------------------------------------------------------------------------------------|\n| `name` | A name for the generated node. Will also serve as a series name in TensorBoard. |\n| `tensor` | A 3-D `float32` `Tensor` of shape `[batch_size, frames, channels]` or a 2-D `float32` `Tensor` of shape `[batch_size, frames]`. |\n| `sample_rate` | A Scalar `float32` `Tensor` indicating the sample rate of the signal in hertz. |\n| `max_outputs` | Max number of batch elements to generate audio for. |\n| `collections` | Optional list of ops.GraphKeys. The collections to add the summary to. Defaults to \\[_ops.GraphKeys.SUMMARIES\\] |\n| `family` | Optional; if provided, used as the prefix of the summary tag name, which controls the tab name used for display on Tensorboard. |\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n\u003cbr /\u003e\n\n| Returns ------- ||\n|---|---|\n| A scalar `Tensor` of type `string`. The serialized `Summary` protocol buffer. ||\n\n\u003cbr /\u003e"]]
View source on GitHub