Update checkstyle tool version to 10.14.2 (#3047)

deepjavalibrary · Mar 28, 2024 · 5eb2b9e · 5eb2b9e
1 parent 091a41c
commit 5eb2b9e
Show file tree

Hide file tree

Showing 4 changed files with 5 additions and 7 deletions.
diff --git a/api/src/main/java/ai/djl/modality/nlp/generate/TextGenerator.java b/api/src/main/java/ai/djl/modality/nlp/generate/TextGenerator.java
@@ -134,9 +134,9 @@ public NDArray greedySearch(NDArray inputIds) throws TranslateException {
      * Generates text using beam search.
      *
      * @param inputIds input tokens ids
-     * @see <a href="https://huggingface.co/blog/how-to-generate">Beam Search</a>
      * @return the output token ids stored as NDArray and the endPosition of each sentence
      * @throws TranslateException if failed run forward
+     * @see <a href="https://huggingface.co/blog/how-to-generate">Beam Search</a>
      */
     @SuppressWarnings("try")
     public NDArray beamSearch(NDArray inputIds) throws TranslateException {
@@ -261,9 +261,9 @@ public NDArray beamSearch(NDArray inputIds) throws TranslateException {
      * Generates text using contrastive search.
      *
      * @param inputIds input token ids
-     * @see <a href="https://huggingface.co/blog/introducing-csearch">Contrastive Search</a>
      * @return the output token ids stored as NDArray
      * @throws TranslateException if forward failed
+     * @see <a href="https://huggingface.co/blog/introducing-csearch">Contrastive Search</a>
      */
     @SuppressWarnings("try")
     public NDArray contrastiveSearch(NDArray inputIds) throws TranslateException {

diff --git a/api/src/main/java/ai/djl/training/tracker/LinearTracker.java b/api/src/main/java/ai/djl/training/tracker/LinearTracker.java
@@ -12,7 +12,6 @@
  */
 package ai.djl.training.tracker;
 
-import ai.djl.training.tracker.WarmUpTracker.Builder;
 import ai.djl.util.Preconditions;
 
 /**

diff --git a/tools/conf/checkstyle.xml b/tools/conf/checkstyle.xml
@@ -156,7 +156,6 @@
                     value="Override, Test, Before, After, BeforeClass, AfterClass"/>
         </module>
         -->
-        <module name="FinalClass"/>
         <module name="HideUtilityClassConstructor"/>
         <module name="InnerTypeLast"/>
         <!--
@@ -284,8 +283,8 @@
         <!-- Javadoc Comments -->
         <module name="AtclauseOrder"/>
         <module name="JavadocMethod">
-            <property name="allowUndeclaredRTE" value="true"/>
-            <property name="allowThrowsTagsForSubclasses" value="true"/>
+            <property name="allowMissingParamTags" value="true"/>
+            <property name="allowMissingReturnTag" value="true"/>
         </module>
         <module name="JavadocParagraph"/>
         <module name="JavadocStyle">

diff --git a/tools/gradle/check.gradle b/tools/gradle/check.gradle
@@ -35,7 +35,7 @@ tasks.withType(Pmd) {
 
 apply plugin: "checkstyle"
 checkstyle {
-    toolVersion = "8.26"
+    toolVersion = "10.14.2"
     ignoreFailures = false
     checkstyleTest.enabled = true
     configProperties = [
-Original file line number
+Diff line change
@@ Expand Up / @@ -12,7 +12,6 @@ @@
      */
     package ai.djl.training.tracker;
-    import ai.djl.training.tracker.WarmUpTracker.Builder;
     import ai.djl.util.Preconditions;
     /**
@@ Expand Down @@