Class AudioSummary

java.lang.Object

org.tensorflow.op.RawOp

org.tensorflow.op.summary.AudioSummary

All Implemented Interfaces:

Shaped, Op, Operand<TString>

@Operator(group="summary")
public final class AudioSummary
extends RawOp
implements Operand<TString>

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 Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AudioSummary.Inputs
static class	AudioSummary.Options	Optional attributes for AudioSummary

Field Summary

Fields

Modifier and Type	Field	Description
static final String	OP_NAME	The name of this op, as known by TensorFlow core engine

Fields inherited from class RawOp

operation

Constructor Summary

Constructors

Constructor	Description
AudioSummary(Operation operation)

Method Summary

Modifier and Type	Method	Description
Output<TString>	asOutput()	Returns the symbolic handle of the tensor.
static AudioSummary	create(Scope scope, Operand<TString> tag, Operand<TFloat32> tensor, Operand<TFloat32> sampleRate, AudioSummary.Options... options)	Factory method to create a class wrapping a new AudioSummaryV2 operation.
static AudioSummary.Options	maxOutputs(Long maxOutputs)	Sets the maxOutputs option.
Output<TString>	summary()	Gets summary.

Methods inherited from class RawOp

equals, hashCode, op, toString

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface Op

env, op

Methods inherited from interface Operand

asTensor, shape, type

Methods inherited from interface Shaped

rank, size

Field Details

OP_NAME

public static final String OP_NAME

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

See Also:

• Constant Field Values

Constructor Details

AudioSummary

public AudioSummary(Operation operation)

Method Details

create

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

Factory method to create a class wrapping a new AudioSummaryV2 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 attribute values

Returns:

a new instance of AudioSummary

maxOutputs

public static AudioSummary.Options maxOutputs(Long maxOutputs)

Sets the maxOutputs option.

Parameters:

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

Returns:

this Options instance.

summary

public Output<TString> summary()

Gets summary. Scalar. Serialized Summary protocol buffer.

Returns:

summary.

asOutput

public Output<TString> asOutput()

Description copied from interface: Operand

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.

Specified by:

asOutput in interface Operand<TString>

See Also:

• OperationBuilder.addInput(Output)