diff --git a/api/src/main/java/ai/djl/ndarray/NDArray.java b/api/src/main/java/ai/djl/ndarray/NDArray.java index 3d93c987850..aaefd2f882b 100644 --- a/api/src/main/java/ai/djl/ndarray/NDArray.java +++ b/api/src/main/java/ai/djl/ndarray/NDArray.java @@ -1016,15 +1016,13 @@ default NDArray like() { return getManager().create(getShape()); } - //////////////////////////////////////// - //////////////////////////////////////// + /* // Operations - //////////////////////////////////////// - //////////////////////////////////////// + */ - //////////////////////////////////////// + /* // Operations: Element Comparison - //////////////////////////////////////// + */ /** * Returns {@code true} if all elements in this {@code NDArray} are equal to the {@link Number}. @@ -1375,9 +1373,9 @@ default boolean allClose(NDArray other, double rtol, double atol, boolean equalN */ NDArray lte(NDArray other); - //////////////////////////////////////// + /* // Operations: Element Arithmetic - //////////////////////////////////////// + */ /** * Adds a number to this {@code NDArray} element-wise. @@ -2006,9 +2004,9 @@ default boolean allClose(NDArray other, double rtol, double atol, boolean equalN */ NDArray minimum(NDArray other); - //////////////////////////////////////// + /* // Operations: Basic Numeric - //////////////////////////////////////// + */ /** * Returns the numerical negative {@code NDArray} element-wise. @@ -2516,9 +2514,9 @@ default boolean allClose(NDArray other, double rtol, double atol, boolean equalN */ NDArray toRadians(); - //////////////////////////////////////// + /* // Operations: Reduction - //////////////////////////////////////// + */ /** * Returns the maximum of this {@code NDArray}. @@ -3161,9 +3159,9 @@ default NDArray trace(int offset) { */ NDArray trace(int offset, int axis1, int axis2); - //////////////////////////////////////// + /* // Operations: Shapes and Arrays Manipulation - //////////////////////////////////////// + */ /** * Splits this {@code NDArray} into multiple sub{@code NDArray}s given sections along first @@ -3885,9 +3883,9 @@ default NDArray concat(NDArray array, int axis) { return getNDArrayInternal().concat(new NDList(array), axis); } - //////////////////////////////////////// + /* // Operations: Logical Op - //////////////////////////////////////// + */ /** * Returns the truth value of this {@code NDArray} AND the other {@code NDArray} element-wise. @@ -4010,9 +4008,9 @@ default NDArray concat(NDArray array, int axis) { */ NDArray logicalNot(); - //////////////////////////////////////// + /* // Operations: Other - //////////////////////////////////////// + */ /** * Returns the indices that would sort this {@code NDArray}. diff --git a/api/src/main/java/ai/djl/ndarray/NDArrays.java b/api/src/main/java/ai/djl/ndarray/NDArrays.java index 0e1c0922a7b..6391b40768a 100644 --- a/api/src/main/java/ai/djl/ndarray/NDArrays.java +++ b/api/src/main/java/ai/djl/ndarray/NDArrays.java @@ -32,9 +32,9 @@ private static void checkInputs(NDArray[] arrays) { } } - //////////////////////////////////////// + /* // Operations: Element Comparison - //////////////////////////////////////// + */ /** * Returns {@code true} if all elements in {@link NDArray} a are equal to {@link NDArray} b. @@ -788,9 +788,9 @@ public static NDArray sequenceMask(NDArray data, NDArray sequenceLength) { return data.sequenceMask(sequenceLength); } - //////////////////////////////////////// + /* // Operations: Element Arithmetic - //////////////////////////////////////// + */ /** * Adds a number to the {@link NDArray} element-wise. diff --git a/api/src/main/java/ai/djl/ndarray/internal/NDArrayEx.java b/api/src/main/java/ai/djl/ndarray/internal/NDArrayEx.java index b25852ad5ab..c4b8742200d 100644 --- a/api/src/main/java/ai/djl/ndarray/internal/NDArrayEx.java +++ b/api/src/main/java/ai/djl/ndarray/internal/NDArrayEx.java @@ -28,9 +28,9 @@ @SuppressWarnings("MissingJavadocMethod") public interface NDArrayEx { - //////////////////////////////////////// + /* // NDArrays - //////////////////////////////////////// + */ /** * Applies reverse division with a scalar - i.e., (n / thisArrayValues). @@ -144,9 +144,9 @@ public interface NDArrayEx { */ NDArray rpowi(Number n); - //////////////////////////////////////// + /* // Activations - //////////////////////////////////////// + */ /** * Computes rectified linear activation. @@ -179,9 +179,9 @@ default NDArray mish() { return getArray().exp().add(1).log2().tanh().mul(getArray()); } - //////////////////////////////////////// + /* // Pooling Operations - //////////////////////////////////////// + */ NDArray maxPool(Shape kernelShape, Shape stride, Shape padding, boolean ceilMode); @@ -201,9 +201,9 @@ NDArray lpPool( NDArray globalLpPool(float normType); - //////////////////////////////////////// + /* // Optimizer - //////////////////////////////////////// + */ void adadeltaUpdate( NDList inputs, @@ -268,9 +268,9 @@ void sgdUpdate( float momentum, boolean lazyUpdate); - //////////////////////////////////////// + /* // Neural network - //////////////////////////////////////// + */ NDList convolution( NDArray input, @@ -398,9 +398,9 @@ NDList lstm( boolean bidirectional, boolean batchFirst); - //////////////////////////////////////// + /* // Image and CV - //////////////////////////////////////// + */ /** * Normalizes a NDArray of shape CHW or NCHW with mean and standard deviation. @@ -489,9 +489,9 @@ default NDArray crop(int x, int y, int width, int height) { // TODO: add TorchVision support NDArray randomColorJitter(float brightness, float contrast, float saturation, float hue); - //////////////////////////////////////// + /* // Miscellaneous - //////////////////////////////////////// + */ /** * Returns an {@link NDArrayIndexer}. diff --git a/engines/mxnet/mxnet-engine/src/main/java/ai/djl/mxnet/engine/MxNDArrayEx.java b/engines/mxnet/mxnet-engine/src/main/java/ai/djl/mxnet/engine/MxNDArrayEx.java index 00a7a0f254b..4ea8d07fadb 100644 --- a/engines/mxnet/mxnet-engine/src/main/java/ai/djl/mxnet/engine/MxNDArrayEx.java +++ b/engines/mxnet/mxnet-engine/src/main/java/ai/djl/mxnet/engine/MxNDArrayEx.java @@ -31,6 +31,7 @@ import java.util.List; /** {@code MxNDArrayEx} is the MXNet implementation of the {@link NDArrayEx}. */ +@SuppressWarnings("dangling-doc-comments") class MxNDArrayEx implements NDArrayEx { private MxNDArray array; diff --git a/engines/mxnet/mxnet-engine/src/main/java/ai/djl/mxnet/jna/JnaUtils.java b/engines/mxnet/mxnet-engine/src/main/java/ai/djl/mxnet/jna/JnaUtils.java index 3ec9aab027b..cb31f3f3592 100644 --- a/engines/mxnet/mxnet-engine/src/main/java/ai/djl/mxnet/jna/JnaUtils.java +++ b/engines/mxnet/mxnet-engine/src/main/java/ai/djl/mxnet/jna/JnaUtils.java @@ -51,7 +51,7 @@ /** * A class containing utilities to interact with the MXNet Engine's Java Native Access (JNA) layer. */ -@SuppressWarnings("MissingJavadocMethod") +@SuppressWarnings({"MissingJavadocMethod", "dangling-doc-comments"}) public final class JnaUtils { public static final ObjectPool REFS = diff --git a/extensions/tokenizers/src/main/java/ai/djl/huggingface/tokenizers/jni/CharSpan.java b/extensions/tokenizers/src/main/java/ai/djl/huggingface/tokenizers/jni/CharSpan.java index 7478d0e8b75..9a15980b486 100644 --- a/extensions/tokenizers/src/main/java/ai/djl/huggingface/tokenizers/jni/CharSpan.java +++ b/extensions/tokenizers/src/main/java/ai/djl/huggingface/tokenizers/jni/CharSpan.java @@ -10,8 +10,6 @@ * OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ - -/** A class holds character span information. */ package ai.djl.huggingface.tokenizers.jni; /** A class holds character span information. */