org.tensorflow.op

Class SummaryOps

java.lang.Object

org.tensorflow.op.SummaryOps

public final class SummaryOps
extends Object

An API for building summary operations as Ops

See Also:

Ops}

Method Summary

Modifier and Type	Method and Description
AudioSummary	audioSummary(Operand<String> tag, Operand<Float> tensor, Operand<Float> sampleRate, AudioSummary.Options... options) Builds an AudioSummary operation
<T extends Number> HistogramSummary	histogramSummary(Operand<String> tag, Operand<T> values) Builds an HistogramSummary operation
<T extends Number> ImageSummary	imageSummary(Operand<String> tag, Operand<T> tensor, ImageSummary.Options... options) Builds an ImageSummary operation
MergeSummary	mergeSummary(Iterable<Operand<String>> inputs) Builds an MergeSummary operation
<T extends Number> ScalarSummary	scalarSummary(Operand<String> tags, Operand<T> values) Builds an ScalarSummary operation
<T> TensorSummary	tensorSummary(Operand<String> tag, Operand<T> tensor, Operand<String> serializedSummaryMetadata) Builds an TensorSummary operation

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

tensorSummary

public <T> TensorSummary tensorSummary(Operand<String> tag,
                                       Operand<T> tensor,
                                       Operand<String> serializedSummaryMetadata)

Builds an TensorSummary operation

Parameters:

tag - A string attached to this summary. Used for organization in TensorBoard.

tensor - A tensor to serialize.

serializedSummaryMetadata - A serialized SummaryMetadata proto. Contains plugin

Returns:

a new instance of TensorSummary

See Also:

TensorSummary

imageSummary

public <T extends Number> ImageSummary imageSummary(Operand<String> tag,
                                                    Operand<T> tensor,
                                                    ImageSummary.Options... options)

Builds an ImageSummary operation

Parameters:

tag - Scalar. Used to build the `tag` attribute of the summary values.

tensor - 4-D of shape `[batch_size, height, width, channels]` where

options - carries optional attributes values

Returns:

a new instance of ImageSummary

See Also:

ImageSummary

scalarSummary

public <T extends Number> ScalarSummary scalarSummary(Operand<String> tags,
                                                      Operand<T> values)

Builds an ScalarSummary operation

Parameters:

tags - Tags for the summary.

values - Same shape as `tags. Values for the summary.

Returns:

a new instance of ScalarSummary

See Also:

ScalarSummary

mergeSummary

public MergeSummary mergeSummary(Iterable<Operand<String>> inputs)

Builds an MergeSummary operation

Parameters:

inputs - Can be of any shape. Each must contain serialized `Summary` protocol

Returns:

a new instance of MergeSummary

See Also:

MergeSummary

audioSummary

public AudioSummary audioSummary(Operand<String> tag,
                                 Operand<Float> tensor,
                                 Operand<Float> sampleRate,
                                 AudioSummary.Options... options)

Builds an AudioSummary operation

Parameters:

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

See Also:

AudioSummary

histogramSummary

public <T extends Number> HistogramSummary histogramSummary(Operand<String> tag,
                                                            Operand<T> values)

Builds an HistogramSummary operation

Parameters:

tag - Scalar. Tag to use for the `Summary.Value`.

values - Any shape. Values to use to build the histogram.

Returns:

a new instance of HistogramSummary

See Also:

HistogramSummary