org.bytedeco.javacpp

Class tensorflow.Scope

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.javacpp.tensorflow.Scope

All Implemented Interfaces:

AutoCloseable

Enclosing class:

tensorflow

@Namespace(value="tensorflow")
 @NoOffset
public static class tensorflow.Scope
extends Pointer

\addtogroup core \{

A Scope object represents a set of related TensorFlow ops that have the same properties such as a common name prefix. A Scope object is a container for TensorFlow Op properties. Op constructors get a Scope object as a mandatory first argument and the constructed op acquires the properties in the object. A simple example: using namespace ops; Scope root = Scope::NewRootScope(); auto c1 = Const(root, { {1, 1} }); auto m = MatMul(root, c1, { {41}, {1} }); GraphDef gdef; Status s = root.ToGraphDef(&gdef); if (!s.ok()) { ... } Scope hierarchy: The Scope class provides various With<> functions that create a new scope. The new scope typically has one property changed while other properties are inherited from the parent scope. NewSubScope(name) method appends name to the prefix of names for ops created within the scope, and WithOpName() changes the suffix which otherwise defaults to the type of the op. Name examples: Scope root = Scope::NewRootScope(); Scope linear = root.NewSubScope("linear"); // W will be named "linear/W" auto W = Variable(linear.WithOpName("W"), {2, 2}, DT_FLOAT); // b will be named "linear/b" auto b = Variable(linear.WithOpName("b"), {2}, DT_FLOAT); auto x = Const(linear, {...}); // name: "linear/Const" auto m = MatMul(linear, x, W); // name: "linear/MatMul" auto r = BiasAdd(linear, m, b); // name: "linear/BiasAdd" Scope lifetime: A new scope is created by calling Scope::NewRootScope. This creates some resources that are shared by all the child scopes that inherit from this scope, directly or transitively. For instance, a new scope creates a new Graph object to which operations are added when the new scope or its children are used by an Op constructor. The new scope also has a Status object which will be used to indicate errors by Op-constructor functions called on any child scope. The Op-constructor functions have to check the scope's status by calling the ok() method before proceeding to construct the op. Thread safety: A Scope object is NOT thread-safe. Threads cannot concurrently call op-constructor functions on the same Scope object.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	tensorflow.Scope.Impl

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
Scope(Pointer p) Pointer cast constructor.
Scope(tensorflow.Scope other)

Method Summary

Modifier and Type	Method and Description
tensorflow.Scope	ClearColocation() Clear all colocation constraints.
tensorflow.Scope	ColocateWith(tensorflow.Operation op) Return a new scope.
tensorflow.Scope	ColocateWith(tensorflow.Output out) Convenience function for above.
tensorflow.Operation	control_deps()
static tensorflow.Scope	DisabledShapeInferenceScope()
tensorflow.Status	DoShapeInference(tensorflow.Node node)
tensorflow.Scope	ExitOnError() Return a new scope.
BytePointer	GetUniqueNameForOp(BytePointer default_name) Return a unique name, using default_name if an op name has not been specified.
String	GetUniqueNameForOp(String default_name)
tensorflow.Graph	graph_as_shared_ptr()
tensorflow.Graph	graph()
tensorflow.Scope.Impl	impl()
static tensorflow.Scope	NewRootScope() Return a new scope.
tensorflow.Scope	NewSubScope(BytePointer child_scope_name) Return a new scope.
tensorflow.Scope	NewSubScope(String child_scope_name)
boolean	ok()
tensorflow.Scope	put(tensorflow.Scope other)
tensorflow.Status	status()
tensorflow.Status	ToGraph(tensorflow.Graph g) If status() is Status::OK(), construct a Graph object using the default GraphConstructorOptions, and return Status::OK if graph construction was successful.
tensorflow.Status	ToGraphDef(tensorflow.GraphDef gdef) If status() is Status::OK(), convert the Graph object stored in this scope to a GraphDef proto and return Status::OK().
void	UpdateBuilder(tensorflow.NodeBuilder builder) Update the builder with properties accumulated in this scope.
void	UpdateStatus(tensorflow.Status s) Update the status on this scope.
tensorflow.Scope	WithAssignedDevice(BytePointer assigned_device) Returns a new scope.
tensorflow.Scope	WithAssignedDevice(String assigned_device)
tensorflow.Scope	WithControlDependencies(tensorflow.Operation control_deps) Return a new scope.
tensorflow.Scope	WithControlDependencies(tensorflow.Output control_dep) Same as above, but convenient to add control dependency on the operation producing the control_dep output.
tensorflow.Scope	WithDevice(BytePointer device) Return a new scope.
tensorflow.Scope	WithDevice(String device)
tensorflow.Scope	WithKernelLabel(BytePointer kernel_label) Return a new scope.
tensorflow.Scope	WithKernelLabel(String kernel_label)
tensorflow.Scope	WithNoControlDependencies() Return a new scope.
tensorflow.Scope	WithOpName(BytePointer op_name) Return a new scope.
tensorflow.Scope	WithOpName(String op_name)

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, hashCode, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, position, put, realloc, setNull, sizeof, toString, totalBytes, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

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

Constructor Detail

Scope

public Scope(Pointer p)

Pointer cast constructor. Invokes Pointer.Pointer(Pointer).

Scope

public Scope(@Const @ByRef
             tensorflow.Scope other)

Method Detail

put

@ByRef
 @Name(value="operator =")
public tensorflow.Scope put(@Const @ByRef
                                                                tensorflow.Scope other)

NewRootScope

@ByVal
public static tensorflow.Scope NewRootScope()

Return a new scope. This creates a new graph and all operations constructed in this graph should use the returned object as the "root" scope.

NewSubScope

@ByVal
public tensorflow.Scope NewSubScope(@StdString
                                            BytePointer child_scope_name)

Return a new scope. Ops created with this scope will have name/child_scope_name as the prefix. The actual name will be unique in the current scope. All other properties are inherited from the current scope. If child_scope_name is empty, the / is elided.

NewSubScope

@ByVal
public tensorflow.Scope NewSubScope(@StdString
                                            String child_scope_name)

WithOpName

@ByVal
public tensorflow.Scope WithOpName(@StdString
                                           BytePointer op_name)

Return a new scope. All ops created within the returned scope will have names of the form name/op_name[_suffix].

WithOpName

@ByVal
public tensorflow.Scope WithOpName(@StdString
                                           String op_name)

WithControlDependencies

@ByVal
public tensorflow.Scope WithControlDependencies(@tensorflow.ArraySlice
                                                        tensorflow.Operation control_deps)

Return a new scope. All ops created within the returned scope will have as control dependencies the union of operations in the control_deps vector and the control dependencies of the current scope.

WithControlDependencies

@ByVal
public tensorflow.Scope WithControlDependencies(@Const @ByRef
                                                        tensorflow.Output control_dep)

Same as above, but convenient to add control dependency on the operation producing the control_dep output.

WithNoControlDependencies

@ByVal
public tensorflow.Scope WithNoControlDependencies()

Return a new scope. All ops created within the returned scope will have no control dependencies on other operations.

WithDevice

@ByVal
public tensorflow.Scope WithDevice(@StdString
                                           BytePointer device)

Return a new scope. All ops created within the returned scope will have the device field set to 'device'.

WithDevice

@ByVal
public tensorflow.Scope WithDevice(@StdString
                                           String device)

WithAssignedDevice

@ByVal
public tensorflow.Scope WithAssignedDevice(@StdString
                                                   BytePointer assigned_device)

Returns a new scope. All ops created within the returned scope will have their assigned device set to assigned_device.

WithAssignedDevice

@ByVal
public tensorflow.Scope WithAssignedDevice(@StdString
                                                   String assigned_device)

ColocateWith

@ByVal
public tensorflow.Scope ColocateWith(@Const @ByRef
                                             tensorflow.Operation op)

Return a new scope. All ops created within the returned scope will be co-located on the device where op is placed. NOTE: This function is intended to be use internal libraries only for controlling placement of ops on to devices. Public use is not encouraged because the implementation of device placement is subject to change.

ColocateWith

@ByVal
public tensorflow.Scope ColocateWith(@Const @ByRef
                                             tensorflow.Output out)

Convenience function for above.

ClearColocation

@ByVal
public tensorflow.Scope ClearColocation()

Clear all colocation constraints.

ExitOnError

@ByVal
public tensorflow.Scope ExitOnError()

Return a new scope. The op-constructor functions taking the returned scope as the scope argument will exit as soon as an error is detected, instead of setting the status on the scope.

WithKernelLabel

@ByVal
public tensorflow.Scope WithKernelLabel(@StdString
                                                BytePointer kernel_label)

Return a new scope. All ops created with the new scope will have kernel_label as the value for their '_kernel' attribute;

WithKernelLabel

@ByVal
public tensorflow.Scope WithKernelLabel(@StdString
                                                String kernel_label)

GetUniqueNameForOp

@StdString
public BytePointer GetUniqueNameForOp(@StdString
                                                  BytePointer default_name)

Return a unique name, using default_name if an op name has not been specified.

GetUniqueNameForOp

@StdString
public String GetUniqueNameForOp(@StdString
                                             String default_name)

UpdateStatus

public void UpdateStatus(@Const @ByVal
                         tensorflow.Status s)

Update the status on this scope. Note: The status object is shared between all children of this scope. If the resulting status is not Status::OK() and exit_on_error_ is set on this scope, this function exits by calling LOG(FATAL).

UpdateBuilder

public void UpdateBuilder(tensorflow.NodeBuilder builder)

Update the builder with properties accumulated in this scope. Does not set status().

ok

@Cast(value="bool")
public boolean ok()

graph

public tensorflow.Graph graph()

graph_as_shared_ptr

@SharedPtr
public tensorflow.Graph graph_as_shared_ptr()

status

@ByVal
public tensorflow.Status status()

ToGraphDef

@ByVal
public tensorflow.Status ToGraphDef(tensorflow.GraphDef gdef)

If status() is Status::OK(), convert the Graph object stored in this scope to a GraphDef proto and return Status::OK(). Otherwise, return the error status as is without performing GraphDef conversion.

ToGraph

@ByVal
public tensorflow.Status ToGraph(tensorflow.Graph g)

If status() is Status::OK(), construct a Graph object using the default GraphConstructorOptions, and return Status::OK if graph construction was successful. Otherwise, return the error status.

DoShapeInference

@ByVal
public tensorflow.Status DoShapeInference(tensorflow.Node node)

DisabledShapeInferenceScope

@ByVal
public static tensorflow.Scope DisabledShapeInferenceScope()

control_deps

@StdVector
public tensorflow.Operation control_deps()

impl

public tensorflow.Scope.Impl impl()