Small docs fixes

docs/tools/requirements.txt

@@ -0,0 +1,3 @@
+GitPython
+requests
+tensorflow-docs

pom.xml

@@ -546,16 +546,37 @@
       </plugin>
       <plugin>
         <artifactId>maven-javadoc-plugin</artifactId>
-        <version>3.6.0</version>
+        <version>3.12.0</version>
+      <configuration>
+          <overview>./docs/overview.md</overview>
+          <!--<includeDependencySources>true</includeDependencySources>-->
+          <bottom>Copyright 2015, 2025 The TensorFlow Authors. All Rights Reserved.</bottom>
+          <additionalJOptions>
+              <additionalJOption>-Xmaxerrs</additionalJOption>
+              <additionalJOption>65536</additionalJOption>
+              <additionalJOption>-Xmaxwarns</additionalJOption>
+              <additionalJOption>65536</additionalJOption>
+          </additionalJOptions>
+          <failOnError>false</failOnError>
+          <minmemory>256m</minmemory>
+          <maxmemory>2048m</maxmemory>
+          <links>
+              <link>https://protobuf.dev/reference/java/api-docs</link>
+              <link>https://bytedeco.org/javacpp/apidocs</link>
+          </links>
+      </configuration>
         <executions>
+            <execution>
+                <id>javadoc-site</id>
+                <goals>
+                    <goal>javadoc</goal>
+                </goals>
+            </execution>
           <execution>
             <id>attach-javadocs</id>
             <goals>
               <goal>jar</goal>
             </goals>
-            <configuration>
-              <quiet>true</quiet>
-            </configuration>
           </execution>
         </executions>
       </plugin>

tensorflow-core/tensorflow-core-api/pom.xml

@@ -220,30 +220,6 @@
         </executions>
       </plugin>
 
-      <plugin>
-        <artifactId>maven-javadoc-plugin</artifactId>
-        <version>3.6.0</version>
-        <executions>
-          <execution>
-            <id>attach-javadocs</id>
-            <goals>
-              <goal>jar</goal>
-            </goals>
-            <configuration>
-              <additionalJOptions>
-                <additionalJOption>-Xmaxerrs</additionalJOption>
-                <additionalJOption>65536</additionalJOption>
-                <additionalJOption>-Xmaxwarns</additionalJOption>
-                <additionalJOption>65536</additionalJOption>
-              </additionalJOptions>
-              <failOnError>false</failOnError>
-              <minmemory>256m</minmemory>
-              <maxmemory>2048m</maxmemory>
-            </configuration>
-          </execution>
-        </executions>
-      </plugin>
-
       <plugin>
         <groupId>org.codehaus.mojo</groupId>
         <artifactId>exec-maven-plugin</artifactId>

tensorflow-core/tensorflow-core-api/src/main/java/module-info.java

@@ -14,6 +14,8 @@
 limitations under the License.
 =======================================================================
 */
+
+/** Core module implementing the TensorFlow Java API and operator definitions. */
 module tensorflow {
   requires transitive org.tensorflow.ndarray;
   requires transitive tensorflow.nativelib;

tensorflow-core/tensorflow-core-api/src/main/java/org/tensorflow/internal/buffer/ByteSequenceTensorBuffer.java

@@ -23,13 +23,11 @@
 import static org.tensorflow.internal.c_api.global.tensorflow.TF_TString_GetSize;
 
 import java.nio.ReadOnlyBufferException;
-import java.util.function.Function;
 import org.bytedeco.javacpp.BytePointer;
 import org.bytedeco.javacpp.Loader;
 import org.bytedeco.javacpp.Pointer;
 import org.bytedeco.javacpp.PointerScope;
 import org.tensorflow.internal.c_api.TF_TString;
-import org.tensorflow.ndarray.NdArray;
 import org.tensorflow.ndarray.buffer.DataBuffer;
 import org.tensorflow.ndarray.impl.buffer.AbstractDataBuffer;
 import org.tensorflow.ndarray.impl.buffer.Validator;
@@ -40,10 +38,9 @@
  * <p>The values are stored as an array of {@link TF_TString}, internally wrapped with {@code
  * tensorflow::tstring}, which is essentially a portable version of {@code std::string}.
  *
- * <p>The data of the buffer must be initialized only once, by calling {@link #init(NdArray,
- * Function)}, and the buffer must have been allocated with enough space (use {@link
- * #computeSize(NdArray, Function)} priory to know exactly how many bytes are required to store the
- * data).
+ * <p>The data of the buffer must be initialized only once, by calling {@link #init}, and the buffer
+ * must have been allocated with enough space (use {@link #computeSize} priory to know exactly how
+ * many bytes are required to store the data).
  *
  * <p>After its data has been initialized, the buffer is read-only as it is not possible to change
  * safely a value without reinitializing the whole data.
@@ -66,8 +63,8 @@ public static <T> long computeSize(ByteSequenceProvider<?> byteSequenceProvider)
    *
    * <p>While it is not enforced programmatically, it is mandatory that this method is called only
    * once after the creation of the buffer. The buffer must have been allocated according to the
-   * same set of data, calling {@link #computeSize(NdArray, Function)} priory to make sure there is
-   * enough space to store it.
+   * same set of data, calling {@link #computeSize} priory to make sure there is enough space to
+   * store it.
    *
    * @param byteSequenceProvider produces sequences of bytes to use as the tensor data
    */

tensorflow-core/tensorflow-core-api/src/main/java/org/tensorflow/internal/types/TUint16Mapper.java

@@ -29,7 +29,7 @@
 import org.tensorflow.types.TUint16;
 
 /**
- * Maps memory of {@link org.tensorflow.proto.DataType#DT_Uint16} tensors to a n-dimensional data
+ * Maps memory of {@link org.tensorflow.proto.DataType#DT_UINT16} tensors to a n-dimensional data
  * space.
  */
 public final class TUint16Mapper extends TensorMapper<TUint16> {

tensorflow-core/tensorflow-core-generator/src/main/java/module-info.java

@@ -14,13 +14,18 @@
 limitations under the License.
 =======================================================================
 */
+
+/**
+ * Code to generate the Java side implementations of TensorFlow's ops based on the TensorFlow op
+ * definition files.
+ */
 module tensorflow.generator {
   requires tensorflow.nativelib;
-  requires java.compiler;
+  requires transitive java.compiler;
   requires com.github.javaparser.core;
   requires com.google.protobuf;
   requires com.google.common;
-  requires com.squareup.javapoet;
+  requires transitive com.squareup.javapoet;
   requires org.commonmark;
   requires spring.core;
 

tensorflow-core/tensorflow-core-native/pom.xml

@@ -639,34 +639,6 @@
           </execution>
         </executions>
       </plugin>
-
-      <plugin>
-        <artifactId>maven-javadoc-plugin</artifactId>
-        <version>3.7.0</version>
-        <executions>
-          <execution>
-            <id>attach-javadocs</id>
-            <goals>
-              <goal>jar</goal>
-            </goals>
-            <configuration>
-              <additionalJOptions>
-                <additionalJOption>-Xmaxerrs</additionalJOption>
-                <additionalJOption>65536</additionalJOption>
-                <additionalJOption>-Xmaxwarns</additionalJOption>
-                <additionalJOption>65536</additionalJOption>
-              </additionalJOptions>
-              <failOnError>false</failOnError>
-              <minmemory>256m</minmemory>
-              <maxmemory>2048m</maxmemory>
-              <links>
-                <link>https://protobuf.dev/reference/java/api-docs</link>
-                <link>http://bytedeco.org/javacpp/apidocs</link>
-              </links>
-            </configuration>
-          </execution>
-        </executions>
-      </plugin>
     </plugins>
   </build>
 </project>

tensorflow-core/tensorflow-core-native/src/main/java/module-info.java

@@ -14,6 +14,8 @@
 limitations under the License.
 =======================================================================
 */
+
+/** Native interop with the TensorFlow C API. */
 module tensorflow.nativelib {
   requires transitive org.bytedeco.javacpp;
   requires transitive com.google.protobuf;

tensorflow-framework/src/main/java/module-info.java

@@ -14,9 +14,11 @@
 limitations under the License.
 =======================================================================
 */
+
+/** Higher level TensorFlow framework containing model definition and training operations. */
 module tensorflow.framework {
-  requires tensorflow;
-  requires org.tensorflow.ndarray;
+  requires transitive tensorflow;
+  requires transitive org.tensorflow.ndarray;
 
   exports org.tensorflow.framework.activations;
   exports org.tensorflow.framework.constraints;

tensorflow-framework/src/main/java/org/tensorflow/framework/losses/impl/LossesHelper.java

@@ -299,7 +299,6 @@ private static <T extends TNumber> Operand<T> reduceWeightedLoss(
    *
    * @param tf the TensorFlow Ops
    * @param losses <code>Operand</code> whose elements contain individual loss measurements.
-   * @param numElements The number of measurable elements in <code>losses</code>.
    * @param <T> the data type of the losses
    * @return A scalar representing the mean of <code>losses</code>. If <code>numElements</code> is
    *     zero, then zero is returned.