tf.compat.v1.summary.audio

Outputs a Summary protocol buffer with audio.

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

Migrate to TF2

For compatibility purposes, when invoked in TF2 where the outermost context is eager mode, this API will check if there is a suitable TF2 summary writer context available, and if so will forward this call to that writer instead. A "suitable" writer context means that the writer is set as the default writer, and there is an associated non-empty value for step (see tf.summary.SummaryWriter.as_default, tf.summary.experimental.set_step or alternatively tf.compat.v1.train.create_global_step). For the forwarded call, the arguments here will be passed to the TF2 implementation of tf.summary.audio, and the return value will be an empty bytestring tensor, to avoid duplicate summary writing. This forwarding is best-effort and not all arguments will be preserved. Additionally:

  • The TF2 op just outputs the data under a single tag that contains multiple samples, rather than multiple tags (i.e. no "/0" or "/1" suffixes).

To migrate to TF2, please use tf.summary.audio instead. Please check Migrating tf.summary usage to TF 2.0 for concrete steps for migration.

How to Map Arguments

TF1 Arg NameTF2 Arg NameNote
namename-
tensordataInput 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_ratesample_rate-
-stepExplicit int64-castable monotonic step value. If omitted, this defaults to tf.summary.experimental.get_step().
max_outputsmax_outputs-
collectionsNot Supported-
familyRemovedPlease use tf.name_scope instead to manage summary name prefix.
-encodingOptional constant str for the desired encoding. Check the docs for tf.summary.audio for latest supported audio formats.
-descriptionOptional 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

nameA name for the generated node. Will also serve as a series name in TensorBoard.
tensorA 3-D float32 Tensor of shape [batch_size, frames, channels] or a 2-D float32 Tensor of shape [batch_size, frames].
sample_rateA Scalar float32 Tensor indicating the sample rate of the signal in hertz.
max_outputsMax number of batch elements to generate audio for.
collectionsOptional list of ops.GraphKeys. The collections to add the summary to. Defaults to [_ops.GraphKeys.SUMMARIES]
familyOptional; if provided, used as the prefix of the summary tag name, which controls the tab name used for display on Tensorboard.

A scalar Tensor of type string. The serialized Summary protocol buffer.