# tf.compat.v1.summary.audio

<br />

|---|
| [![](https://www.tensorflow.org/images/GitHub-Mark-32px.png) View source on GitHub](https://github.com/tensorflow/tensorflow/blob/v2.7.4/tensorflow/python/summary/summary.py#L264-L346) |

Outputs a `Summary` protocol buffer with audio.

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

<br />

## Migrate to TF2

<br />

> [!CAUTION]
> **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.

This API is not compatible with eager execution or [`tf.function`](https://www.tensorflow.org/versions/r2.7/api_docs/python/tf/function). To migrate
to TF2, please use [`tf.summary.audio`](https://www.tensorflow.org/versions/r2.7/api_docs/python/tf/summary/audio) instead. Please check
[Migrating tf.summary usage to
TF 2.0](https://www.tensorflow.org/tensorboard/migrate#in_tf_1x) for concrete
steps for migration.

#### How to Map Arguments

| TF1 Arg Name | TF2 Arg Name | Note |
|---|---|---|
| `name` | `name` | - |
| `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. |
| `sample_rate` | `sample_rate` | - |
| - | `step` | Explicit int64-castable monotonic step value. If omitted, this defaults to [`tf.summary.experimental.get_step()`](https://www.tensorflow.org/versions/r2.7/api_docs/python/tf/summary/experimental/get_step). |
| `max_outputs` | `max_outputs` | - |
| `collections` | Not Supported | - |
| `family` | Removed | Please use [`tf.name_scope`](https://www.tensorflow.org/versions/r2.7/api_docs/python/tf/name_scope) instead to manage summary name prefix. |
| - | `encoding` | Optional constant str for the desired encoding. Check the docs for [`tf.summary.audio`](https://www.tensorflow.org/versions/r2.7/api_docs/python/tf/summary/audio) for latest supported audio formats. |
| - | `description` | Optional long-form `str` description for the summary. Markdown is supported. Defaults to empty. |

<br />

<br />

## 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

<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 />