# tf.summary.audio

<br />

|---|---|
| [![](https://www.tensorflow.org/images/tf_logo_32px.png) TensorFlow 2 version](https://www.tensorflow.org/api_docs/python/tf/summary/audio) | [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v1.15.0/tensorflow/python/summary/summary.py#L184-L230) |

Outputs a `Summary` protocol buffer with audio.

#### View aliases


**Compat aliases for migration**

See
[Migration guide](https://www.tensorflow.org/guide/migrate) for
more details.

[`tf.compat.v1.summary.audio`](https://www.tensorflow.org/api_docs/python/tf/compat/v1/summary/audio)

<br />

    tf.summary.audio(
        name, tensor, sample_rate, max_outputs=3, collections=None, family=None
    )

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

<br />

<br />

<br />

| ## 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\] |
| `family` | Optional; if provided, used as the prefix of the summary tag name, which controls the tab name used for display on Tensorboard. |

<br />

<br />

<br />

<br />

| ## Returns ||
|---|---|
| A scalar `Tensor` of type `string`. The serialized `Summary` protocol buffer. ||

<br />