Reformat code, fix javadocs

tensorflow · JimClarke5 · Oct 8, 2020 · Oct 27, 2020 · Nov 17, 2020 · Nov 19, 2020
commit 7526b7e9db059f50cb369ced4f8ee26674852f85
diff --git a/tensorflow-framework/src/main/java/org/tensorflow/framework/op/FrameworkOps.java b/tensorflow-framework/src/main/java/org/tensorflow/framework/op/FrameworkOps.java
@@ -30,11 +30,10 @@
  */
 public class FrameworkOps {
   public final Ops coreOps;
-  private final Scope scope;
-
   public final NnOps nn;
   public final SetsOps sets;
   public final MathOps math;
+  private final Scope scope;
 
   /**
    * Creates a FrameworkOps instance with the provided scope
@@ -62,8 +61,43 @@ private FrameworkOps(Ops coreOps) {
     math = new MathOps(this);
   }
 
+  /**
+   * Creates an API for building operations in the provided execution environment
+   *
+   * @param env the exection environment
+   * @return the FrameworkOps
+   */
+  public static FrameworkOps create(ExecutionEnvironment env) {
+    return new FrameworkOps(new Scope(env));
+  }
+
+  /**
+   * Creates an API for building operations in the default eager execution environment
+   *
+   * <p>Invoking this method is equivalent to {@code
+   * FrameworkOps.create(EagerSession.getDefault())}.
+   *
+   * @return the FrameworkOps
+   */
+  public static FrameworkOps create() {
+    return new FrameworkOps(new Scope(EagerSession.getDefault()));
+  }
+
+  /**
+   * Creates an API for building operations in the default eager execution environment
+   *
+   * @param coreOps the TensorFlow core Ops
+   * @return the FrameworkOps
+   */
+  public static FrameworkOps create(Ops coreOps) {
+    return new FrameworkOps(coreOps);
+  }
 
-  /** Returns the current {@link Scope scope} of this API */
+  /**
+   * Returns the current {@link Scope scope} of this API
+   *
+   * @return the current {@link Scope scope} of this API
+   */
   public final Scope scope() {
     return scope;
   }
@@ -81,6 +115,9 @@ public final Ops coreOps() {
    * Returns an API that builds operations with the provided name prefix.
    *
    * <p>@link Scope#withSubScope(String)}
+   *
+   * @param childScopeName the name of the child scope
+   * @return the FrameworkOps
    */
   public FrameworkOps withSubScope(String childScopeName) {
     return new FrameworkOps(scope.withSubScope(childScopeName));
@@ -90,6 +127,9 @@ public FrameworkOps withSubScope(String childScopeName) {
    * Returns an API that uses the provided name for an op.
    *
    * <p>{@link Scope#withName(String)}
+   *
+   * @param opName the name of the scope
+   * @return the FrameworkOps
    */
   public FrameworkOps withName(String opName) {
     return new FrameworkOps(scope.withName(opName));
@@ -99,6 +139,9 @@ public FrameworkOps withName(String opName) {
    * Returns an API that places the created operations on the device(s) matching the provided spec.
    *
    * <p>{@link Scope#withDevice(DeviceSpec)}
+   *
+   * @param deviceSpec the device specification for the scope
+   * @return the FrameworkOps
    */
   public FrameworkOps withDevice(DeviceSpec deviceSpec) {
     return new FrameworkOps(scope.withDevice(deviceSpec));
@@ -108,32 +151,11 @@ public FrameworkOps withDevice(DeviceSpec deviceSpec) {
    * Returns an API that adds operations to the graph with the provided control dependencies.
    *
    * <p>{@link Scope#withControlDependencies(Iterable)}
+   *
+   * @param controls the operations
+   * @return the FrameworkOps
    */
   public FrameworkOps withControlDependencies(Iterable<Op> controls) {
     return new FrameworkOps(scope.withControlDependencies(controls));
   }
-
-  /** Creates an API for building operations in the provided execution environment */
-  public static FrameworkOps create(ExecutionEnvironment env) {
-    return new FrameworkOps(new Scope(env));
-  }
-
-  /**
-   * Creates an API for building operations in the default eager execution environment
-   *
-   * <p>Invoking this method is equivalent to {@code
-   * FrameworkOps.create(EagerSession.getDefault())}.
-   */
-  public static FrameworkOps create() {
-    return new FrameworkOps(new Scope(EagerSession.getDefault()));
-  }
-
-  /**
-   * Creates an API for building operations in the default eager execution environment
-   *
-   * @param coreOps the TensorFlow core Ops
-   */
-  public static FrameworkOps create(Ops coreOps) {
-    return new FrameworkOps(coreOps);
-  }
 }
diff --git a/tensorflow-framework/src/main/java/org/tensorflow/framework/op/MathOps.java b/tensorflow-framework/src/main/java/org/tensorflow/framework/op/MathOps.java
@@ -15,7 +15,6 @@
 package org.tensorflow.framework.op;
 
 import org.tensorflow.Operand;
-import org.tensorflow.op.Ops;
 import org.tensorflow.op.Scope;
 import org.tensorflow.op.core.Constant;
 import org.tensorflow.op.core.ReduceSum;
@@ -26,42 +25,41 @@
 import org.tensorflow.op.math.Square;
 import org.tensorflow.types.family.TNumber;
 
-import static org.tensorflow.framework.utils.CastHelper.cast;
-
 public class MathOps {
-    private final Scope scope;
+  private final Scope scope;
 
-    private final FrameworkOps frameworkOps;
+  private final FrameworkOps frameworkOps;
 
-    /**
-     * Creates Framework {@code nn} Operations
-     *
-     * @param frameworkOps the TensorFLow framework Ops
-     */
-    MathOps(FrameworkOps frameworkOps) {
-        this.scope = frameworkOps.scope();
-        this.frameworkOps = frameworkOps;
-    }
+  /**
+   * Creates Framework {@code nn} Operations
+   *
+   * @param frameworkOps the TensorFLow framework Ops
+   */
+  MathOps(FrameworkOps frameworkOps) {
+    this.scope = frameworkOps.scope();
+    this.frameworkOps = frameworkOps;
+  }
 
-    /**
-     * Normalizes along dimension axis using an L2 norm.
-     *
-     * @param x the input
-     * @param axis Dimension along which to normalize.
-     * @param <T> the data type for the input and the result
-     * @return the normalized values based on L2 norm
-     */
-    public  <T extends TNumber> Operand<T> l2Normalize(Operand<T> x, int[] axis) {
-        Operand<T> squareSum =
-                ReduceSum.create(scope,
-                        Square.create(scope, x),
-                        Constant.vectorOf(scope, axis),
-                        ReduceSum.keepDims(Boolean.TRUE));
-        Operand<T> invNorm =
-                Rsqrt.create(scope,
-                        Maximum.create(scope, squareSum,
-                                Cast.create(scope,
-                                        Constant.scalarOf(scope, 1e-12F), x.type())));
-        return Mul.create(scope, x, invNorm);
-    }
+  /**
+   * Normalizes along dimension axis using an L2 norm.
+   *
+   * @param x the input
+   * @param axis Dimension along which to normalize.
+   * @param <T> the data type for the input and the result
+   * @return the normalized values based on L2 norm
+   */
+  public <T extends TNumber> Operand<T> l2Normalize(Operand<T> x, int[] axis) {
+    Operand<T> squareSum =
+        ReduceSum.create(
+            scope,
+            Square.create(scope, x),
+            Constant.vectorOf(scope, axis),
+            ReduceSum.keepDims(Boolean.TRUE));
+    Operand<T> invNorm =
+        Rsqrt.create(
+            scope,
+            Maximum.create(
+                scope, squareSum, Cast.create(scope, Constant.scalarOf(scope, 1e-12F), x.type())));
+    return Mul.create(scope, x, invNorm);
+  }
 }