[incubator-mxnet] branch master updated: [MXNET-319] Reduce Scala Warning messages (#11789)

[ns...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

nswamy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-mxnet.git


The following commit(s) were added to refs/heads/master by this push:
     new a94fcf9  [MXNET-319] Reduce Scala Warning messages (#11789)
a94fcf9 is described below

commit a94fcf929427cfb74359ebe73f0ca8788cea900f
Author: Lanking <la...@live.com>
AuthorDate: Sun Jul 22 02:15:57 2018 -0700

    [MXNET-319] Reduce Scala Warning messages (#11789)
    
    * Reduce Scala Warning messages
---
 .../core/src/main/scala/org/apache/mxnet/NDArray.scala         |  6 +++++-
 .../core/src/main/scala/org/apache/mxnet/RecordIO.scala        |  2 +-
 .../src/main/scala/org/apache/mxnet/APIDocGenerator.scala      | 10 ++++++----
 .../src/main/scala/org/apache/mxnet/spark/MXNDArray.scala      |  2 +-
 .../src/main/scala/org/apache/mxnet/spark/MXNetModel.scala     |  4 ++--
 5 files changed, 15 insertions(+), 9 deletions(-)

diff --git a/scala-package/core/src/main/scala/org/apache/mxnet/NDArray.scala b/scala-package/core/src/main/scala/org/apache/mxnet/NDArray.scala
index 58ab5ca..548c30b 100644
--- a/scala-package/core/src/main/scala/org/apache/mxnet/NDArray.scala
+++ b/scala-package/core/src/main/scala/org/apache/mxnet/NDArray.scala
@@ -89,7 +89,11 @@ object NDArray extends NDArrayBase {
         output match {
           case nd: NDArray => (Array(nd), Array(nd.handle))
           case ndFuncRet: NDArrayFuncReturn => (ndFuncRet.arr, ndFuncRet.arr.map(_.handle))
-          case ndArr: Seq[NDArray] => (ndArr.toArray, ndArr.toArray.map(_.handle))
+         // Seq[NDArray] erasure problem explained here https://stackoverflow.com/questions/1094173/
+          case ndArr: Seq[NDArray @unchecked] =>
+            if (ndArr.head.isInstanceOf[NDArray]) (ndArr.toArray, ndArr.toArray.map(_.handle))
+            else throw new IllegalArgumentException(
+              "Unsupported out var type, should be NDArray or subclass of Seq[NDArray]")
           case _ => throw new IllegalArgumentException(
             "Unsupported out var type, should be NDArray or subclass of Seq[NDArray]")
         }
diff --git a/scala-package/core/src/main/scala/org/apache/mxnet/RecordIO.scala b/scala-package/core/src/main/scala/org/apache/mxnet/RecordIO.scala
index efd4384..ee3e950 100644
--- a/scala-package/core/src/main/scala/org/apache/mxnet/RecordIO.scala
+++ b/scala-package/core/src/main/scala/org/apache/mxnet/RecordIO.scala
@@ -98,7 +98,7 @@ object MXRecordIO {
 
   /**
    * pack an string into MXImageRecord.
-   * @param
+   * @param header
    *  header of the image record.
    *  header.label an array.
    * @param s string to pack
diff --git a/scala-package/macros/src/main/scala/org/apache/mxnet/APIDocGenerator.scala b/scala-package/macros/src/main/scala/org/apache/mxnet/APIDocGenerator.scala
index b446fb3..b4efa65 100644
--- a/scala-package/macros/src/main/scala/org/apache/mxnet/APIDocGenerator.scala
+++ b/scala-package/macros/src/main/scala/org/apache/mxnet/APIDocGenerator.scala
@@ -22,8 +22,7 @@ import org.apache.mxnet.utils.CToScalaUtils
 import java.io._
 import java.security.MessageDigest
 
-import scala.collection.mutable.ListBuffer
-import scala.io.Source
+import scala.collection.mutable.{ArrayBuffer, ListBuffer}
 
 /**
   * This object will generate the Scala documentation of the new Scala API
@@ -109,9 +108,12 @@ private[mxnet] object APIDocGenerator{
 
   // Generate ScalaDoc type
   def generateAPIDocFromBackend(func : absClassFunction, withParam : Boolean = true) : String = {
-    val desc = func.desc.split("\n").map({ currStr =>
-      s"  * $currStr<br>"
+    val desc = ArrayBuffer[String]()
+    desc += "  * <pre>"
+      func.desc.split("\n").foreach({ currStr =>
+      desc += s"  * $currStr"
     })
+    desc += "  * </pre>"
     val params = func.listOfArgs.map({ absClassArg =>
       val currArgName = absClassArg.argName match {
                 case "var" => "vari"
diff --git a/scala-package/spark/src/main/scala/org/apache/mxnet/spark/MXNDArray.scala b/scala-package/spark/src/main/scala/org/apache/mxnet/spark/MXNDArray.scala
index 38ceb7d..da078fc 100644
--- a/scala-package/spark/src/main/scala/org/apache/mxnet/spark/MXNDArray.scala
+++ b/scala-package/spark/src/main/scala/org/apache/mxnet/spark/MXNDArray.scala
@@ -20,7 +20,7 @@ package org.apache.mxnet.spark
 import org.apache.mxnet.NDArray
 
 /**
- * A wrapper for serialize & deserialize [[org.apache.mxnet.NDArray]] in spark job
+ * A wrapper for serialize & deserialize <pre>[[org.apache.mxnet.NDArray]]</pre> in spark job
  * @author Yizhi Liu
  */
 class MXNDArray(@transient private var ndArray: NDArray) extends Serializable {
diff --git a/scala-package/spark/src/main/scala/org/apache/mxnet/spark/MXNetModel.scala b/scala-package/spark/src/main/scala/org/apache/mxnet/spark/MXNetModel.scala
index 23683f7..2ecc2c8 100644
--- a/scala-package/spark/src/main/scala/org/apache/mxnet/spark/MXNetModel.scala
+++ b/scala-package/spark/src/main/scala/org/apache/mxnet/spark/MXNetModel.scala
@@ -23,7 +23,7 @@ import org.apache.spark.SparkContext
 import org.apache.spark.mllib.linalg.Vector
 
 /**
- * Wrapper for [[org.apache.mxnet.Model]] which used in Spark application
+ * Wrapper for <pre>[[org.apache.mxnet.Model]]</pre> which used in Spark application
  * @author Yizhi Liu
  */
 class MXNetModel private[mxnet](
@@ -38,7 +38,7 @@ class MXNetModel private[mxnet](
   val serializedModel = model.serialize()
 
   /**
-   * Get inner model [[FeedForward]]
+   * Get inner model <pre>[[FeedForward]]</pre>
    * @return the underlying model used to train & predict
    */
   def innerModel: FeedForward = {