AudioSummary

public final class AudioSummary

Outputs a `Summary` protocol buffer with audio.

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.

Nested Classes

class AudioSummary.Options Optional attributes for AudioSummary  

Constants

String OP_NAME The name of this op, as known by TensorFlow core engine

Public Methods

Output<TString>
asOutput()
Returns the symbolic handle of the tensor.
static AudioSummary
create(Scope scope, Operand<TString> tag, Operand<TFloat32> tensor, Operand<TFloat32> sampleRate, Options... options)
Factory method to create a class wrapping a new AudioSummary operation.
static AudioSummary.Options
maxOutputs(Long maxOutputs)
Output<TString>
summary()
Scalar.

Inherited Methods

Constants

public static final String OP_NAME

The name of this op, as known by TensorFlow core engine

Constant Value: "AudioSummaryV2"

Public Methods

public Output<TString> asOutput ()

Returns the symbolic handle of the tensor.

Inputs to TensorFlow operations are outputs of another TensorFlow operation. This method is used to obtain a symbolic handle that represents the computation of the input.

public static AudioSummary create (Scope scope, Operand<TString> tag, Operand<TFloat32> tensor, Operand<TFloat32> sampleRate, Options... options)

Factory method to create a class wrapping a new AudioSummary operation.

Parameters
scope current scope
tag Scalar. Used to build the `tag` attribute of the summary values.
tensor 2-D of shape `[batch_size, frames]`.
sampleRate The sample rate of the signal in hertz.
options carries optional attributes values
Returns
  • a new instance of AudioSummary

public static AudioSummary.Options maxOutputs (Long maxOutputs)

Parameters
maxOutputs Max number of batch elements to generate audio for.

public Output<TString> summary ()

Scalar. Serialized `Summary` protocol buffer.