Package org.tensorflow

Class Graph

java.lang.Object

org.tensorflow.Graph

All Implemented Interfaces:

java.lang.AutoCloseable

public final class Graph
extends java.lang.Object
implements java.lang.AutoCloseable

A data flow graph representing a TensorFlow computation.

Instances of a Graph are thread-safe.

WARNING: Resources consumed by the Graph object must be explicitly freed by invoking the close() method then the Graph object is no longer needed.

Constructor Summary

Constructors

Constructor	Description
Graph()	Create an empty Graph.

Method Summary

Modifier and Type	Method	Description
Output<?>[]	addGradients(java.lang.String prefix, Output<?>[] y, Output<?>[] x, Output<?>[] dx)	Adds operations to compute the partial derivatives of sum of ys w.r.t xs, i.e., d(y_1 + y_2 + ...)/dx_1, d(y_1 + y_2 + ...)/dx_2...
Output<?>[]	addGradients(Output<?> y, Output<?>[] x)	Adds operations to compute the partial derivatives of sum of ys w.r.t xs, i.e., dy/dx_1, dy/dx_2...
void	close()	Release resources associated with the Graph.
void	importGraphDef(byte[] graphDef)	Import a serialized representation of a TensorFlow graph.
void	importGraphDef(byte[] graphDef, java.lang.String prefix)	Import a serialized representation of a TensorFlow graph.
OperationBuilder	opBuilder(java.lang.String type, java.lang.String name)	Returns a builder to add Operations to the Graph.
Operation	operation(java.lang.String name)	Returns the operation (node in the Graph) with the provided name.
java.util.Iterator<Operation>	operations()	Iterator over all the Operations in the graph.
byte[]	toGraphDef()	Generate a serialized representation of the Graph.

Methods inherited from class java.lang.Object

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

Constructor Detail

Graph

public Graph()

Create an empty Graph.

Method Detail

close

public void close()

Release resources associated with the Graph.

Blocks until there are no active Session instances referring to this Graph. A Graph is not usable after close returns.

Specified by:

close in interface java.lang.AutoCloseable

operation

public Operation operation(java.lang.String name)

Returns the operation (node in the Graph) with the provided name.

Or null if no such operation exists in the Graph.

operations

public java.util.Iterator<Operation> operations()

Iterator over all the Operations in the graph.

The order of iteration is unspecified. Consumers of the iterator will receive no notification should the underlying graph change during iteration.

opBuilder

public OperationBuilder opBuilder(java.lang.String type,
                                  java.lang.String name)

Returns a builder to add Operations to the Graph.

Parameters:

type - of the Operation (i.e., identifies the computation to be performed)

name - to refer to the created Operation in the graph.

Returns:

an OperationBuilder, which will add the Operation to the graph when OperationBuilder.build() is invoked. If OperationBuilder.build() is not invoked, then some resources may leak.

importGraphDef

public void importGraphDef(byte[] graphDef)
                    throws java.lang.IllegalArgumentException

Import a serialized representation of a TensorFlow graph.

The serialized representation of the graph, often referred to as a GraphDef, can be generated by toGraphDef() and equivalents in other language APIs.

Throws:

java.lang.IllegalArgumentException - if graphDef is not a recognized serialization of a graph.

See Also:

importGraphDef(byte[], String)

importGraphDef

public void importGraphDef(byte[] graphDef,
                           java.lang.String prefix)
                    throws java.lang.IllegalArgumentException

Import a serialized representation of a TensorFlow graph.

Parameters:

graphDef - the serialized representation of a TensorFlow graph.

prefix - a prefix that will be prepended to names in graphDef

Throws:

java.lang.IllegalArgumentException - if graphDef is not a recognized serialization of a graph.

See Also:

importGraphDef(byte[])

toGraphDef

public byte[] toGraphDef()

Generate a serialized representation of the Graph.

See Also:

importGraphDef(byte[]), importGraphDef(byte[], String)

addGradients

public Output<?>[] addGradients(java.lang.String prefix,
                                Output<?>[] y,
                                Output<?>[] x,
                                Output<?>[] dx)

Adds operations to compute the partial derivatives of sum of ys w.r.t xs, i.e., d(y_1 + y_2 + ...)/dx_1, d(y_1 + y_2 + ...)/dx_2...

dx are used as initial gradients (which represent the symbolic partial derivatives of some loss function L w.r.t. y). dx must be null or have size of y.

If dx is null, the implementation will use dx of OnesLike for all shapes in y.

prefix is used as the name prefix applied to all nodes added to the graph to compute gradients. It must be unique within the provided graph or the operation will fail.

If prefix is null, then one will be chosen automatically.

Parameters:

prefix - unique string prefix applied before the names of nodes added to the graph to compute gradients. If null, a default one will be chosen.

y - output of the function to derive

x - inputs of the function for which partial derivatives are computed

dx - if not null, the partial derivatives of some loss function L w.r.t. y

Returns:

the partial derivatives dy with the size of x

addGradients

public Output<?>[] addGradients(Output<?> y,
                                Output<?>[] x)

Adds operations to compute the partial derivatives of sum of ys w.r.t xs, i.e., dy/dx_1, dy/dx_2...

This is a simplified version of where {@code y} is a single output, {@code dx} is null and {@code prefix} is null.

Parameters:

y - output of the function to derive

x - inputs of the function for which partial derivatives are computed

Returns:

the partial derivatives dy with the size of x