Class StringFormat

java.lang.Object

org.tensorflow.op.RawOp

org.tensorflow.op.strings.StringFormat

All Implemented Interfaces:

Shaped, Op, Operand<TString>

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

Formats a string template using a list of tensors. Formats a string template using a list of tensors, pretty-printing tensor summaries.

Nested Class Summary

Nested Classes

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

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

Modifier and Type	Field	Description
protected final Operation	operation

Constructor Summary

Constructors

Constructor	Description
StringFormat(Operation operation)

Method Summary

Modifier and Type	Method	Description
Output<TString>	asOutput()	Returns the symbolic handle of the tensor.
static StringFormat	create(Scope scope, Iterable<Operand<?>> inputs, StringFormat.Options... options)	Factory method to create a class wrapping a new StringFormat operation.
Output<TString>	output()	Gets output. = The resulting string scalar.
static StringFormat.Options	placeholder(String placeholder)	Sets the placeholder option.
static StringFormat.Options	summarize(Long summarize)	Sets the summarize option.
static StringFormat.Options	template(String template)	Sets the template option.

Methods inherited from class RawOp

equals, hashCode, op, toString

Modifier and Type	Method	Description
final boolean	equals(Object obj)
final int	hashCode()
Operation	op()	Return this unit of computation as a single Operation.
final String	toString()

Methods inherited from class Object

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

Methods inherited from interface Op

env

Modifier and Type	Method	Description
default ExecutionEnvironment	env()	Return the execution environment this op was created in.

Methods inherited from interface Operand

asTensor, shape, type

Modifier and Type	Method	Description
default TString	asTensor()	Returns the tensor at this operand.
default Shape	shape()	Returns the (possibly partially known) shape of the tensor referred to by the Output of this operand.
default Class<TString>	type()	Returns the tensor type of this operand

Methods inherited from interface Shaped

rank, size

Modifier and Type	Method	Description
default int	rank()
default long	size()	Computes and returns the total size of this container, in number of values.

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

StringFormat

public StringFormat(Operation operation)

Method Details

create

@Endpoint(describeByClass=true)
public static StringFormat create(Scope scope,
 Iterable<Operand<?>> inputs,
 StringFormat.Options... options)

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

Parameters:

scope - current scope

inputs - The list of tensors to format into the placeholder string.

options - carries optional attribute values

Returns:

a new instance of StringFormat

template

public static StringFormat.Options template(String template)

Sets the template option.

Parameters:

template - A string, the template to format tensor summaries into.

Returns:

this Options instance.

placeholder

public static StringFormat.Options placeholder(String placeholder)

Sets the placeholder option.

Parameters:

placeholder - A string, at each placeholder in the template a subsequent tensor summary will be inserted.

Returns:

this Options instance.

summarize

public static StringFormat.Options summarize(Long summarize)

Sets the summarize option.

Parameters:

summarize - When formatting the tensor summaries print the first and last summarize entries of each tensor dimension.

Returns:

this Options instance.

output

public Output<TString> output()

Gets output. = The resulting string scalar.

Returns:

output.

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)