Add note about why gradientFuncs is required

rnett · rnett · commit 36a6e3089564 · 2021-11-04T18:09:30.000-07:00
Signed-off-by: Ryan Nett &lt;JNett96@gmail.com&gt;
diff --git a/tensorflow-core/tensorflow-core-api/src/main/java/org/tensorflow/TensorFlow.java b/tensorflow-core/tensorflow-core-api/src/main/java/org/tensorflow/TensorFlow.java
@@ -151,7 +151,11 @@ private TensorFlow() {}
     }
   }
 
-  // to keep them from getting GC'd
+  /**
+   * Keeps references to custom gradient functions to prevent them from being deallocated.
+   *
+   * <b>Required for correctness</b>
+   */
   private static final Set<GradFunc> gradientFuncs =
       Collections.newSetFromMap(new IdentityHashMap<>());
 

Original file line number	Diff line number	Diff line change
`@@ -151,7 +151,11 @@ private TensorFlow() {}`
`151`	`151`	`}`
`152`	`152`	`}`
`153`	`153`
`154`		`- // to keep them from getting GC'd`
	`154`	`+ /**`
	`155`	`+ * Keeps references to custom gradient functions to prevent them from being deallocated.`
	`156`	`+ *`
	`157`	`+ * <b>Required for correctness</b>`
	`158`	`+ */`
`155`	`159`	`private static final Set<GradFunc> gradientFuncs =`
`156`	`160`	`Collections.newSetFromMap(new IdentityHashMap<>());`
`157`	`161`