Add base scope, test

Signed-off-by: Ryan Nett <[email protected]>

Author: rnett

tensorflow-core/tensorflow-core-api/src/gen/annotations/org/tensorflow/op/Ops.java

@@ -354,14 +354,14 @@ public final class Ops {
 
   public final SparseOps sparse;
 
-  public final BitwiseOps bitwise;
-
   public final TpuOps tpu;
 
-  public final AudioOps audio;
+  public final BitwiseOps bitwise;
 
   public final MathOps math;
 
+  public final AudioOps audio;
+
   public final SignalOps signal;
 
   public final TrainOps train;
@@ -385,10 +385,10 @@ private Ops(Scope scope) {
     random = new RandomOps(this);
     strings = new StringsOps(this);
     sparse = new SparseOps(this);
-    bitwise = new BitwiseOps(this);
     tpu = new TpuOps(this);
-    audio = new AudioOps(this);
+    bitwise = new BitwiseOps(this);
     math = new MathOps(this);
+    audio = new AudioOps(this);
     signal = new SignalOps(this);
     train = new TrainOps(this);
     quantization = new QuantizationOps(this);
@@ -8185,7 +8185,7 @@ public final Scope scope() {
    * Creates an API for building operations in the provided execution environment
    */
   public static Ops create(ExecutionEnvironment env) {
-    return new Ops(new Scope(env));
+    return new Ops(env.baseScope());
   }
 
   /**
@@ -8194,6 +8194,6 @@ public static Ops create(ExecutionEnvironment env) {
    * <p>Invoking this method is equivalent to {@code Ops.create(EagerSession.getDefault())}.
    */
   public static Ops create() {
-    return new Ops(new Scope(EagerSession.getDefault()));
+    return create(EagerSession.getDefault());
   }
 }

tensorflow-core/tensorflow-core-api/src/main/java/org/tensorflow/EagerSession.java

@@ -29,6 +29,8 @@
 import org.tensorflow.internal.c_api.TFE_ContextOptions;
 import org.tensorflow.internal.c_api.TF_Status;
 import org.tensorflow.op.Op;
+import org.tensorflow.op.Ops;
+import org.tensorflow.op.Scope;
 import org.tensorflow.op.core.Assign;
 import org.tensorflow.op.core.Placeholder;
 import org.tensorflow.op.core.Variable;
@@ -306,6 +308,15 @@ public void checkInput(Op input) {
     }
   }
 
+  @Override
+  public synchronized Scope baseScope() {
+    if(baseScope == null){
+      baseScope = new Scope(this);
+    }
+
+    return baseScope;
+  }
+
   TFE_Context nativeHandle() {
     checkSession();
     return nativeHandle;
@@ -362,6 +373,8 @@ void detach(Pointer... resources) {
   private final WeakPointerScope nativeResources;
   private TFE_Context nativeHandle;
 
+  private Scope baseScope = null;
+
   private EagerSession(Options options) {
     this.nativeResources = new WeakPointerScope();
     this.nativeHandle = allocate(options.async, options.devicePlacementPolicy.code, options.config);

tensorflow-core/tensorflow-core-api/src/main/java/org/tensorflow/ExecutionEnvironment.java

@@ -16,6 +16,7 @@
 package org.tensorflow;
 
 import org.tensorflow.op.Op;
+import org.tensorflow.op.Scope;
 
 /**
  * Defines an environment for creating and executing TensorFlow {@link Operation}s.
@@ -71,4 +72,9 @@ default boolean isEager() {
   default boolean isGraph() {
     return environmentType() == Types.GRAPH;
   }
+
+  /**
+   * Get the top level scope for this execution environment.  Is cached, which is necessary to prevent name collisions.
+   */
+  Scope baseScope();
 }

tensorflow-core/tensorflow-core-api/src/main/java/org/tensorflow/Graph.java

@@ -52,6 +52,7 @@
 import org.tensorflow.ndarray.StdArrays;
 import org.tensorflow.op.Op;
 import org.tensorflow.op.Ops;
+import org.tensorflow.op.Scope;
 import org.tensorflow.op.core.Constant;
 import org.tensorflow.op.core.Identity;
 import org.tensorflow.op.core.NoOp;
@@ -390,6 +391,15 @@ public void checkInput(Op input) {
     }
   }
 
+  @Override
+  public synchronized Scope baseScope() {
+    if(baseScope == null){
+      baseScope = new Scope(this);
+    }
+
+    return baseScope;
+  }
+
   /**
    * Import a representation of a TensorFlow graph.
    *
@@ -692,6 +702,7 @@ synchronized SaverDef saverDef() {
   private TF_Graph nativeHandle;
   private int refcount = 0;
   private SaverDef saverDef;
+  private Scope baseScope = null;
 
   private final List<Op> initializers = new ArrayList<>();
 

tensorflow-core/tensorflow-core-api/src/main/java/org/tensorflow/op/Scope.java

@@ -79,6 +79,8 @@ public final class Scope {
 
   /**
    * Create a new top-level scope.
+   * <p>
+   * <b>For internal use only</b>, use {@link ExecutionEnvironment#baseScope()} if you need a base level scope.
    *
    * @param env The execution environment used by the scope.
    */

tensorflow-core/tensorflow-core-api/src/test/java/org/tensorflow/ScopeTest.java

@@ -0,0 +1,41 @@
+/*
+  Copyright 2021 The TensorFlow Authors. All Rights Reserved.
+
+ Licensed under the Apache License, Version 2.0 (the "License");
+ you may not use this file except in compliance with the License.
+ You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ ==============================================================================
+ */
+package org.tensorflow;
+
+import org.junit.jupiter.api.Test;
+import org.tensorflow.op.Ops;
+
+public class ScopeTest {
+  @Test
+  public void testSeparateOps(){
+    try(Graph g = new Graph()){
+      Ops tf1 = Ops.create(g);
+      Ops tf2 = Ops.create(g);
+
+      tf1.constant(2);
+      tf1.withName("Constant2").constant(2);
+      tf1.withSubScope("Scope").constant(2);
+      tf1.withSubScope("Scope").withName("Constant4").constant(2);
+
+      tf2.constant(2);
+      tf2.withName("Constant2").constant(2);
+      tf2.withSubScope("Scope").constant(2);
+      tf2.withSubScope("Scope").withName("Constant4").constant(2);
+
+    }
+  }
+}

tensorflow-core/tensorflow-core-generator/src/main/java/org/tensorflow/processor/operator/OperatorProcessor.java

@@ -470,8 +470,8 @@ private static TypeSpec buildTopClass(OpsSpec spec) {
 
     MethodSpec.Builder ctorBuilder =
         MethodSpec.constructorBuilder()
-            .addModifiers(Modifier.PRIVATE)
             .addParameter(T_SCOPE, "scope")
+            .addModifiers(Modifier.PRIVATE)
             .addStatement("this.scope = scope", T_SCOPE);
 
     TypeSpec.Builder opsBuilder =
@@ -578,7 +578,7 @@ private static TypeSpec buildTopClass(OpsSpec spec) {
             .addModifiers(Modifier.PUBLIC, Modifier.STATIC)
             .addParameter(T_EXEC_ENV, "env")
             .returns(T_OPS)
-            .addStatement("return new Ops(new $T(env))", T_SCOPE)
+            .addStatement("return new Ops(env.baseScope())")
             .addJavadoc(
                 "Creates an API for building operations in the provided execution environment\n")
             .build());
@@ -587,7 +587,7 @@ private static TypeSpec buildTopClass(OpsSpec spec) {
         MethodSpec.methodBuilder("create")
             .addModifiers(Modifier.PUBLIC, Modifier.STATIC)
             .returns(T_OPS)
-            .addStatement("return new Ops(new $T($T.getDefault()))", T_SCOPE, T_EAGER_SESSION)
+            .addStatement("return create($T.getDefault())", T_EAGER_SESSION)
             .addJavadoc(
                 "Creates an API for building operations in the default eager execution environment\n\n"
                     + "<p>Invoking this method is equivalent to {@code Ops.create(EagerSession.getDefault())}.\n")