org.tensorflow

Class OperationBuilder

java.lang.Object

org.tensorflow.OperationBuilder

public final class OperationBuilder
extends Object

A builder for Operations in a Graph.

Instances of an OperationBuilder are not thread-safe.

A builder for adding Operations to a Graph. For example, the following uses the builder to create an operation that produces the constant "3" as its output:

 // g is a Graph instance.
 try (Tensor c1 = Tensor.create(3.0f)) {
   g.opBuilder("Const", "MyConst")
       .setAttr("dtype", c1.dataType())
       .setAttr("value", c1)
       .build();
 }
 

Method Summary

Modifier and Type	Method and Description
OperationBuilder	addControlInput(Operation control) Ensure that the operation does not execute before the control operation does.
OperationBuilder	addInput(Output<?> input) Returns the builder to create an operation.
OperationBuilder	addInputList(Output<?>[] inputs)
Operation	build() Add the Operation being built to the Graph.
OperationBuilder	setAttr(String name, boolean value)
OperationBuilder	setAttr(String name, boolean[] value)
OperationBuilder	setAttr(String name, byte[] value)
OperationBuilder	setAttr(String name, DataType value)
OperationBuilder	setAttr(String name, DataType[] value)
OperationBuilder	setAttr(String name, float value)
OperationBuilder	setAttr(String name, float[] value)
OperationBuilder	setAttr(String name, long value)
OperationBuilder	setAttr(String name, long[] value)
OperationBuilder	setAttr(String name, Shape value)
OperationBuilder	setAttr(String name, Shape[] value)
OperationBuilder	setAttr(String name, String value)
OperationBuilder	setAttr(String name, String[] value)
OperationBuilder	setAttr(String name, Tensor<?> value)
OperationBuilder	setAttr(String name, Tensor<?>[] value)
OperationBuilder	setDevice(String device)

Methods inherited from class java.lang.Object

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

Method Detail

build

public Operation build()

Add the Operation being built to the Graph.

The OperationBuilder is not usable after build() returns.

addInput

public OperationBuilder addInput(Output<?> input)

Returns the builder to create an operation.

Inputs to TensorFlow operations are outputs of another TensorFlow operation. This method is used to add a input to a OperationBuilder.

Parameters:

input - Output supposed to be the input of the OperationBuilder.

Returns:

the OperationBuilder instance for chaining.

addControlInput

public OperationBuilder addControlInput(Operation control)

Ensure that the operation does not execute before the control operation does.

A control input is an Operation that must be executed before running the operation currently being built.

For example, an Assert operation may be added as a control input for this operation. The Assert now behaves as a pre-condition that will always verify itself before running the operation.

Parameters:

control - operation that must be executed before running this operation.

Returns:

the OperationBuilder instance for chaining.

addInputList

public OperationBuilder addInputList(Output<?>[] inputs)

setDevice

public OperationBuilder setDevice(String device)

setAttr

public OperationBuilder setAttr(String name,
                                String value)

setAttr

public OperationBuilder setAttr(String name,
                                byte[] value)

setAttr

public OperationBuilder setAttr(String name,
                                long value)

setAttr

public OperationBuilder setAttr(String name,
                                long[] value)

setAttr

public OperationBuilder setAttr(String name,
                                float value)

setAttr

public OperationBuilder setAttr(String name,
                                float[] value)

setAttr

public OperationBuilder setAttr(String name,
                                boolean value)

setAttr

public OperationBuilder setAttr(String name,
                                boolean[] value)

setAttr

public OperationBuilder setAttr(String name,
                                DataType value)

setAttr

public OperationBuilder setAttr(String name,
                                DataType[] value)

setAttr

public OperationBuilder setAttr(String name,
                                Tensor<?> value)

setAttr

public OperationBuilder setAttr(String name,
                                Tensor<?>[] value)

setAttr

public OperationBuilder setAttr(String name,
                                Shape value)

setAttr

public OperationBuilder setAttr(String name,
                                Shape[] value)

setAttr

public OperationBuilder setAttr(String name,
                                String[] value)