Scaladoc build errors

[zachgk]

Description

When compiling the docs, there are a number of errors and warnings while generating the scaladocs. Sample output is below:

Execute "cd /home/ubuntu/incubator-mxnet/docs/../scala-package; scaladoc `find . -type f -name "*.scala" | egrep "\/core|\/infer" | egrep -v "Suite"`; exit 0"
./core/src/main/scala/org/apache/mxnet/FeedForward.scala:23: error: object slf4j is not a member of package org
import org.slf4j.{Logger, LoggerFactory}
           ^
./core/src/main/scala/org/apache/mxnet/FeedForward.scala:61: error: not found: type Logger
  val logger: Logger = LoggerFactory.getLogger(classOf[FeedForward])
              ^
./core/src/main/scala/org/apache/mxnet/FeedForward.scala:61: error: not found: value LoggerFactory
  val logger: Logger = LoggerFactory.getLogger(classOf[FeedForward])
                       ^
./core/src/main/scala/org/apache/mxnet/FeedForward.scala:292: error: not found: type Logger
          logger: Logger, workLoadList: Seq[Float]): Unit = {
                  ^
./core/src/main/scala/org/apache/mxnet/FeedForward.scala:369: error: not found: type Logger
                  batchEndCallback: BatchEndCallback = null, logger: Logger = FeedForward.logger,
                                                                     ^
./core/src/main/scala/org/apache/mxnet/FeedForward.scala:328: error: not found: type Logger
          batchEndCallback: BatchEndCallback, logger: Logger,
                                                      ^
./core/src/main/scala/org/apache/mxnet/FeedForward.scala:464: error: not found: type Logger
  private val logger: Logger = LoggerFactory.getLogger(classOf[FeedForward])
                      ^
./core/src/main/scala/org/apache/mxnet/FeedForward.scala:464: error: not found: value LoggerFactory
  private val logger: Logger = LoggerFactory.getLogger(classOf[FeedForward])
                               ^
./core/src/main/scala/org/apache/mxnet/FeedForward.scala:542: error: not found: type Logger
    private var logger: Logger = FeedForward.logger
                        ^
./core/src/main/scala/org/apache/mxnet/FeedForward.scala:697: error: not found: type Logger
    def setLogger(logger: Logger): Builder = {
                          ^
./core/src/main/scala/org/apache/mxnet/IO.scala:23: error: object slf4j is not a member of package org
import org.slf4j.LoggerFactory
           ^
./core/src/main/scala/org/apache/mxnet/IO.scala:35: error: not found: value LoggerFactory
  private val logger = LoggerFactory.getLogger(classOf[DataIter])
                       ^
./core/src/main/scala/org/apache/mxnet/IO.scala:385: error: not found: value LoggerFactory
  private val logger = LoggerFactory.getLogger(classOf[DataDesc])
                       ^
./core/src/main/scala/org/apache/mxnet/SymbolAPI.scala:22: error: not found: type AddSymbolAPIs
@AddSymbolAPIs(false)
 ^
./core/src/main/scala/org/apache/mxnet/util/WarnIfNotDisposed.scala:20: error: object slf4j is not a member of package org
import org.slf4j.{Logger, LoggerFactory}
           ^
./core/src/main/scala/org/apache/mxnet/util/WarnIfNotDisposed.scala:27: error: not found: type Logger
  private val logger: Logger = LoggerFactory.getLogger(classOf[WarnIfNotDisposed])
                      ^
./core/src/main/scala/org/apache/mxnet/util/WarnIfNotDisposed.scala:27: error: not found: value LoggerFactory
  private val logger: Logger = LoggerFactory.getLogger(classOf[WarnIfNotDisposed])
                               ^
./core/src/main/scala/org/apache/mxnet/util/NativeLibraryLoader.scala:22: error: object slf4j is not a member of package org
import org.slf4j.{Logger, LoggerFactory}
           ^
./core/src/main/scala/org/apache/mxnet/util/NativeLibraryLoader.scala:27: error: not found: type Logger
  private val logger: Logger = LoggerFactory.getLogger(classOf[NativeLibraryLoader])
                      ^
./core/src/main/scala/org/apache/mxnet/util/NativeLibraryLoader.scala:27: error: not found: value LoggerFactory
  private val logger: Logger = LoggerFactory.getLogger(classOf[NativeLibraryLoader])
                               ^
./core/src/main/scala/org/apache/mxnet/Monitor.scala:21: error: object slf4j is not a member of package org
import org.slf4j.LoggerFactory
           ^
./core/src/main/scala/org/apache/mxnet/Monitor.scala:37: error: not found: value LoggerFactory
  private val logger = LoggerFactory.getLogger(classOf[Monitor])
                       ^
./core/src/main/scala/org/apache/mxnet/Serializer.scala:24: error: object commons is not a member of package org.apache
import org.apache.commons.codec.binary.Base64
                  ^
./core/src/main/scala/org/apache/mxnet/Serializer.scala:52: error: not found: value Base64
    new String(Base64.encodeBase64(bytes.array), UTF8)
               ^
./core/src/main/scala/org/apache/mxnet/Serializer.scala:56: error: not found: value Base64
    ByteBuffer.wrap(Base64.decodeBase64(str.getBytes(UTF8)))
                    ^
./core/src/main/scala/org/apache/mxnet/ExecutorManager.scala:21: error: object slf4j is not a member of package org
import org.slf4j.{LoggerFactory, Logger}
           ^
./core/src/main/scala/org/apache/mxnet/ExecutorManager.scala:174: error: not found: type Logger
  val logger: Logger = LoggerFactory.getLogger(classOf[DataParallelExecutorManager])
              ^
./core/src/main/scala/org/apache/mxnet/ExecutorManager.scala:174: error: not found: value LoggerFactory
  val logger: Logger = LoggerFactory.getLogger(classOf[DataParallelExecutorManager])
                       ^
./core/src/main/scala/org/apache/mxnet/Base.scala:21: error: object slf4j is not a member of package org
import org.slf4j.{LoggerFactory, Logger}
           ^
./core/src/main/scala/org/apache/mxnet/Base.scala:24: error: not found: type Logger
  private val logger: Logger = LoggerFactory.getLogger("MXNetJVM")
                      ^
./core/src/main/scala/org/apache/mxnet/Base.scala:24: error: not found: value LoggerFactory
  private val logger: Logger = LoggerFactory.getLogger("MXNetJVM")
                               ^
./core/src/main/scala/org/apache/mxnet/KVStore.scala:23: error: object slf4j is not a member of package org
import org.slf4j.{Logger, LoggerFactory}
           ^
./core/src/main/scala/org/apache/mxnet/KVStore.scala:56: error: not found: type Logger
  private val logger: Logger = LoggerFactory.getLogger(classOf[KVStore])
                      ^
./core/src/main/scala/org/apache/mxnet/KVStore.scala:56: error: not found: value LoggerFactory
  private val logger: Logger = LoggerFactory.getLogger(classOf[KVStore])
                               ^
./core/src/main/scala/org/apache/mxnet/NDArrayCollector.scala:22: error: object slf4j is not a member of package org
import org.slf4j.LoggerFactory
           ^
./core/src/main/scala/org/apache/mxnet/NDArrayCollector.scala:68: error: not found: value LoggerFactory
  private val logger = LoggerFactory.getLogger(classOf[NDArrayCollector])
                       ^
./core/src/main/scala/org/apache/mxnet/ResourceScope.scala:22: error: object slf4j is not a member of package org
import org.slf4j.LoggerFactory
           ^
./core/src/main/scala/org/apache/mxnet/ResourceScope.scala:90: error: not found: value LoggerFactory
  private val logger = LoggerFactory.getLogger(classOf[ResourceScope])
                       ^
./core/src/main/scala/org/apache/mxnet/io/MXDataIter.scala:24: error: object slf4j is not a member of package org
import org.slf4j.LoggerFactory
           ^
./core/src/main/scala/org/apache/mxnet/io/MXDataIter.scala:38: error: not found: value LoggerFactory
  private val logger = LoggerFactory.getLogger(classOf[MXDataIter])
                       ^
./core/src/main/scala/org/apache/mxnet/io/ResizeIter.scala:24: error: object slf4j is not a member of package org
import org.slf4j.LoggerFactory
           ^
./core/src/main/scala/org/apache/mxnet/io/ResizeIter.scala:43: error: not found: value LoggerFactory
  private val logger = LoggerFactory.getLogger(classOf[ResizeIter])
                       ^
./core/src/main/scala/org/apache/mxnet/io/PrefetchingIter.scala:21: error: object slf4j is not a member of package org
import org.slf4j.LoggerFactory
           ^
./core/src/main/scala/org/apache/mxnet/io/PrefetchingIter.scala:41: error: not found: value LoggerFactory
  private val logger = LoggerFactory.getLogger(classOf[PrefetchingIter])
                       ^
./core/src/main/scala/org/apache/mxnet/io/NDArrayIter.scala:25: error: object slf4j is not a member of package org
import org.slf4j.LoggerFactory
           ^
./core/src/main/scala/org/apache/mxnet/io/NDArrayIter.scala:69: error: not found: value LoggerFactory
  private val logger = LoggerFactory.getLogger(classOf[NDArrayIter])
                       ^
./core/src/main/scala/org/apache/mxnet/NDArray.scala:24: error: object slf4j is not a member of package org
import org.slf4j.LoggerFactory
           ^
./core/src/main/scala/org/apache/mxnet/NDArray.scala:34: error: not found: type AddNDArrayFunctions
@AddNDArrayFunctions(false)
 ^
./core/src/main/scala/org/apache/mxnet/NDArray.scala:37: error: not found: value LoggerFactory
  private val logger = LoggerFactory.getLogger(classOf[NDArray])
                       ^
./core/src/main/scala/org/apache/mxnet/Symbol.scala:22: error: object slf4j is not a member of package org
import org.slf4j.{Logger, LoggerFactory}
           ^
./core/src/main/scala/org/apache/mxnet/Symbol.scala:33: error: not found: type Logger
  private val logger: Logger = LoggerFactory.getLogger(classOf[Symbol])
                      ^
./core/src/main/scala/org/apache/mxnet/Symbol.scala:33: error: not found: value LoggerFactory
  private val logger: Logger = LoggerFactory.getLogger(classOf[Symbol])
                               ^
./core/src/main/scala/org/apache/mxnet/Symbol.scala:836: error: not found: type AddSymbolFunctions
@AddSymbolFunctions(false)
 ^
./core/src/main/scala/org/apache/mxnet/Symbol.scala:839: error: not found: value LoggerFactory
  private val logger = LoggerFactory.getLogger(classOf[Symbol])
                       ^
./core/src/main/scala/org/apache/mxnet/contrib/NDArray.scala:21: error: object AddNDArrayFunctions is not a member of package org.apache.mxnet
import org.apache.mxnet.AddNDArrayFunctions
       ^
./core/src/main/scala/org/apache/mxnet/contrib/NDArray.scala:23: error: not found: type AddNDArrayFunctions
@AddNDArrayFunctions(true)
 ^
./core/src/main/scala/org/apache/mxnet/contrib/Symbol.scala:21: error: object AddSymbolFunctions is not a member of package org.apache.mxnet
import org.apache.mxnet.AddSymbolFunctions
       ^
./core/src/main/scala/org/apache/mxnet/contrib/Symbol.scala:23: error: not found: type AddSymbolFunctions
@AddSymbolFunctions(true)
 ^
./core/src/main/scala/org/apache/mxnet/Model.scala:22: error: object slf4j is not a member of package org
import org.slf4j.LoggerFactory
           ^
./core/src/main/scala/org/apache/mxnet/Model.scala:31: error: not found: value LoggerFactory
  private val logger = LoggerFactory.getLogger(classOf[Model])
                       ^
./core/src/main/scala/org/apache/mxnet/NDArrayAPI.scala:18: error: not found: type AddNDArrayAPIs
@AddNDArrayAPIs(false)
 ^
./core/src/main/scala/org/apache/mxnet/LRScheduler.scala:19: error: object slf4j is not a member of package org
import org.slf4j.LoggerFactory
           ^
./core/src/main/scala/org/apache/mxnet/LRScheduler.scala:56: error: not found: value LoggerFactory
  private val logger = LoggerFactory.getLogger(classOf[FactorScheduler])
                       ^
./core/src/main/scala/org/apache/mxnet/module/Module.scala:26: error: object slf4j is not a member of package org
import org.slf4j.LoggerFactory
           ^
./core/src/main/scala/org/apache/mxnet/module/Module.scala:46: error: not found: value LoggerFactory
  private val logger = LoggerFactory.getLogger(classOf[Module])
                       ^
./core/src/main/scala/org/apache/mxnet/module/DataParallelExecutorGroup.scala:23: error: object slf4j is not a member of package org
import org.slf4j.{Logger, LoggerFactory}
           ^
./core/src/main/scala/org/apache/mxnet/module/DataParallelExecutorGroup.scala:29: error: not found: type Logger
  private val logger: Logger = LoggerFactory.getLogger(classOf[DataParallelExecutorGroup])
                      ^
./core/src/main/scala/org/apache/mxnet/module/DataParallelExecutorGroup.scala:29: error: not found: value LoggerFactory
  private val logger: Logger = LoggerFactory.getLogger(classOf[DataParallelExecutorGroup])
                               ^
./core/src/main/scala/org/apache/mxnet/module/BaseModule.scala:24: error: object slf4j is not a member of package org
import org.slf4j.LoggerFactory
           ^
./core/src/main/scala/org/apache/mxnet/module/BaseModule.scala:25: error: object slf4j is not a member of package org
import org.slf4j.Logger
           ^
./core/src/main/scala/org/apache/mxnet/module/BaseModule.scala:36: error: not found: type Logger
    typeName: String, throws: Boolean, logger: Logger): Unit = {
                                               ^
./core/src/main/scala/org/apache/mxnet/module/BaseModule.scala:136: error: not found: value LoggerFactory
  private val logger = LoggerFactory.getLogger(classOf[BaseModule])
                       ^
./core/src/main/scala/org/apache/mxnet/module/BucketingModule.scala:21: error: object slf4j is not a member of package org
import org.slf4j.LoggerFactory
           ^
./core/src/main/scala/org/apache/mxnet/module/BucketingModule.scala:22: error: object slf4j is not a member of package org
import org.slf4j.Logger
           ^
./core/src/main/scala/org/apache/mxnet/module/BucketingModule.scala:41: error: not found: value LoggerFactory
  private val logger = LoggerFactory.getLogger(classOf[BucketingModule])
                       ^
./core/src/main/scala/org/apache/mxnet/module/SequentialModule.scala:21: error: object slf4j is not a member of package org
import org.slf4j.LoggerFactory
           ^
./core/src/main/scala/org/apache/mxnet/module/SequentialModule.scala:34: error: not found: value LoggerFactory
  private val logger = LoggerFactory.getLogger(classOf[SequentialModule])
                       ^
./core/src/main/scala/org/apache/mxnet/Executor.scala:21: error: object slf4j is not a member of package org
import org.slf4j.{Logger, LoggerFactory}
           ^
./core/src/main/scala/org/apache/mxnet/Executor.scala:60: error: not found: type Logger
  private val logger: Logger = LoggerFactory.getLogger(classOf[Executor])
                      ^
./core/src/main/scala/org/apache/mxnet/Executor.scala:60: error: not found: value LoggerFactory
  private val logger: Logger = LoggerFactory.getLogger(classOf[Executor])
                               ^
./core/src/main/scala/org/apache/mxnet/KVStoreServer.scala:21: error: object slf4j is not a member of package org
import org.slf4j.{Logger, LoggerFactory}
           ^
./core/src/main/scala/org/apache/mxnet/KVStoreServer.scala:24: error: not found: type Logger
  private val logger: Logger = LoggerFactory.getLogger(classOf[KVStoreServer])
                      ^
./core/src/main/scala/org/apache/mxnet/KVStoreServer.scala:24: error: not found: value LoggerFactory
  private val logger: Logger = LoggerFactory.getLogger(classOf[KVStoreServer])
                               ^
./core/src/main/scala/org/apache/mxnet/KVStoreServer.scala:49: error: not found: type Logger
  private val logger: Logger = LoggerFactory.getLogger(classOf[KVStoreServer])
                      ^
./core/src/main/scala/org/apache/mxnet/KVStoreServer.scala:49: error: not found: value LoggerFactory
  private val logger: Logger = LoggerFactory.getLogger(classOf[KVStoreServer])
                               ^
./core/src/main/scala/org/apache/mxnet/Callback.scala:20: error: object slf4j is not a member of package org
import org.slf4j.{Logger, LoggerFactory}
           ^
./core/src/main/scala/org/apache/mxnet/Callback.scala:28: error: not found: type Logger
    private val logger: Logger = LoggerFactory.getLogger(classOf[Speedometer])
                        ^
./core/src/main/scala/org/apache/mxnet/Callback.scala:28: error: not found: value LoggerFactory
    private val logger: Logger = LoggerFactory.getLogger(classOf[Speedometer])
                                 ^
./examples/src/main/scala/org/apache/mxnetexamples/infer/objectdetector/SSDClassifierExample.scala:22: error: object benchmark is not a member of package org.apache.mxnetexamples
import org.apache.mxnetexamples.benchmark.CLIParserBase
                                ^
./examples/src/main/scala/org/apache/mxnetexamples/infer/objectdetector/SSDClassifierExample.scala:28: error: object kohsuke is not a member of package org
import org.kohsuke.args4j.{CmdLineParser, Option}
           ^
./examples/src/main/scala/org/apache/mxnetexamples/infer/objectdetector/SSDClassifierExample.scala:29: error: object slf4j is not a member of package org
import org.slf4j.LoggerFactory
           ^
./examples/src/main/scala/org/apache/mxnetexamples/infer/objectdetector/SSDClassifierExample.scala:34: error: object InferBase is not a member of package org.apache.mxnetexamples
import org.apache.mxnetexamples.InferBase
       ^
./examples/src/main/scala/org/apache/mxnetexamples/infer/objectdetector/SSDClassifierExample.scala:205: error: not found: type InferBase
  extends InferBase {
          ^
./examples/src/main/scala/org/apache/mxnetexamples/infer/objectdetector/SSDClassifierExample.scala:48: error: not found: value LoggerFactory
  private val logger = LoggerFactory.getLogger(classOf[SSDClassifierExample])
                       ^
./examples/src/main/scala/org/apache/mxnetexamples/infer/objectdetector/SSDClassifierExample.scala:195: error: not found: type CLIParserBase
class CLIParser extends CLIParserBase {
                        ^
./examples/src/main/scala/org/apache/mxnetexamples/infer/objectdetector/SSDClassifierExample.scala:112: error: not found: type CmdLineParser
    val parser : CmdLineParser = new CmdLineParser(inst)
                 ^
./examples/src/main/scala/org/apache/mxnetexamples/infer/objectdetector/SSDClassifierExample.scala:112: error: not found: type CmdLineParser
    val parser : CmdLineParser = new CmdLineParser(inst)
                                     ^
./examples/src/main/scala/org/apache/mxnetexamples/infer/objectdetector/SSDClassifierExample.scala:196: error: class Option is abstract; cannot be instantiated
  @Option(name = "--model-path-prefix", usage = "the input model directory and prefix of the model")
   ^
warning: no valid targets for annotation on value modelPathPrefix - it is discarded unused. You may specify targets with meta-annotations, e.g. @(<error> @getter)
./examples/src/main/scala/org/apache/mxnetexamples/infer/objectdetector/SSDClassifierExample.scala:198: error: class Option is abstract; cannot be instantiated
  @Option(name = "--input-image", usage = "the input image")
   ^
warning: no valid targets for annotation on value inputImagePath - it is discarded unused. You may specify targets with meta-annotations, e.g. @(<error> @getter)
./examples/src/main/scala/org/apache/mxnetexamples/infer/objectdetector/SSDClassifierExample.scala:200: error: class Option is abstract; cannot be instantiated
  @Option(name = "--input-dir", usage = "the input batch of images directory")
   ^
warning: no valid targets for annotation on value inputImageDir - it is discarded unused. You may specify targets with meta-annotations, e.g. @(<error> @getter)
warning: no valid targets for annotation on value modelPathPrefix - it is discarded unused. You may specify targets with meta-annotations, e.g. @(<error> @getter)
warning: no valid targets for annotation on value inputImagePath - it is discarded unused. You may specify targets with meta-annotations, e.g. @(<error> @getter)
warning: no valid targets for annotation on value inputImageDir - it is discarded unused. You may specify targets with meta-annotations, e.g. @(<error> @getter)
warning: there were 12 deprecation warnings; re-run with -deprecation for details
warning: there were 17 feature warnings; re-run with -feature for details
model contains 149 documentable templates
./core/src/main/scala/org/apache/mxnet/ResourceScope.scala:29: warning: Could not find any member to link for "NativeResource".
/**
^
./core/src/main/scala/org/apache/mxnet/Executor.scala:260: warning: Could not find any member to link for "IllegalArgumentException".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/Executor.scala:248: warning: Could not find any member to link for "IllegalArgumentException".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/Executor.scala:236: warning: Could not find any member to link for "IllegalArgumentException".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/Executor.scala:224: warning: Could not find any member to link for "IllegalArgumentException".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/module/BaseModule.scala:368: warning: Could not find any member to link for "IOException".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/module/SequentialModule.scala:369: warning: Could not find any member to link for "grad1_dev1,".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/module/SequentialModule.scala:345: warning: Could not find any member to link for "out1_dev1,".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/module/BaseModule.scala:206: warning: Could not find any member to link for "out1_batch1,".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/module/BucketingModule.scala:362: warning: Could not find any member to link for "grad1_dev1,".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/module/BucketingModule.scala:338: warning: Could not find any member to link for "out1_dev1,".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/module/BaseModule.scala:518: warning: Could not find any member to link for "grad1_dev1,".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/module/BaseModule.scala:500: warning: Could not find any member to link for "out1_dev1,".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/module/DataParallelExecutorGroup.scala:538: warning: Could not find any member to link for "grad1_dev1,".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/module/DataParallelExecutorGroup.scala:516: warning: Could not find any member to link for "out1_dev1,".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/module/Module.scala:509: warning: Could not find any member to link for "grad1_dev1,".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/module/Module.scala:485: warning: Could not find any member to link for "out1_dev1,".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/SymbolAPIBase.scala:1473: warning: Could not find any member to link for "batch_index,".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/NDArrayAPIBase.scala:1473: warning: Could not find any member to link for "batch_index,".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/ResourceScope.scala:45: warning: Could not find any member to link for "NativeResource".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/ResourceScope.scala:45: warning: Could not find any member to link for "NativeResource.close()".
  /**
  ^
29 warnings found
120 errors found
Execute "rm -rf /home/ubuntu/incubator-mxnet/docs/_build/html/api/scala/docs"
Execute "mkdir -p /home/ubuntu/incubator-mxnet/docs/_build/html/api/scala/docs"
Execute "cd /home/ubuntu/incubator-mxnet/docs/../scala-package && mv -f index /home/ubuntu/incubator-mxnet/docs/_build/html/api/scala/docs"
Execute "cd /home/ubuntu/incubator-mxnet/docs/../scala-package && mv -f index.html /home/ubuntu/incubator-mxnet/docs/_build/html/api/scala/docs"
Execute "cd /home/ubuntu/incubator-mxnet/docs/../scala-package && mv -f org /home/ubuntu/incubator-mxnet/docs/_build/html/api/scala/docs"
Execute "cd /home/ubuntu/incubator-mxnet/docs/../scala-package && mv -f lib /home/ubuntu/incubator-mxnet/docs/_build/html/api/scala/docs"
Execute "cd /home/ubuntu/incubator-mxnet/docs/../scala-package && mv -f index.js /home/ubuntu/incubator-mxnet/docs/_build/html/api/scala/docs"
Execute "cd /home/ubuntu/incubator-mxnet/docs/../scala-package && mv -f package.html /home/ubuntu/incubator-mxnet/docs/_build/html/api/scala/docs"

[zachgk]

@mxnet-label-bot[Doc, Scala]

[zachgk]

Some errors are suppressed by default and should be noted. The build output after a partial fix from bb7f4b8 (to clear up the output a bit) but with the flags to show the warnings (-deprecated -feature) is:

ubuntu@ip-172-31-68-239:~/incubator-mxnet/scala-package$ scaladoc `find . -type f -name "*.scala" | egrep "\.\/core|\.\/infer" | egrep -v "Suite"` -classpath `find native -name "*.jar" | grep "target/lib/" | tr '\n' ':'`:`find macros -name "*-SNAPSHOT.jar"` -deprecation -feature
./core/src/main/scala/org/apache/mxnet/IO.scala:343: warning: @deprecated now takes two arguments; see the scaladoc.
  @deprecated
   ^
./core/src/main/scala/org/apache/mxnet/IO.scala:347: warning: @deprecated now takes two arguments; see the scaladoc.
  @deprecated
   ^
./core/src/main/scala/org/apache/mxnet/IO.scala:407: warning: @deprecated now takes two arguments; see the scaladoc.
  @deprecated
   ^
./core/src/main/scala/org/apache/mxnet/IO.scala:408: warning: implicit conversion method ListMap2Descs should be enabled
by making the implicit value scala.language.implicitConversions visible.
This can be achieved by adding the import clause 'import scala.language.implicitConversions'
or by setting the compiler option -language:implicitConversions.
See the Scala docs for value scala.language.implicitConversions for a discussion
why the feature should be explicitly enabled.
  implicit def ListMap2Descs(shapes: ListMap[String, Shape]): IndexedSeq[DataDesc] = {
               ^
./core/src/main/scala/org/apache/mxnet/Visualization.scala:149: warning: postfix operator ! should be enabled
by making the implicit value scala.language.postfixOps visible.
This can be achieved by adding the import clause 'import scala.language.postfixOps'
or by setting the compiler option -language:postfixOps.
See the Scala docs for value scala.language.postfixOps for a discussion
why the feature should be explicitly enabled.
        args !
             ^
./core/src/main/scala/org/apache/mxnet/javaapi/Shape.scala:49: warning: implicit conversion method fromShape should be enabled
by making the implicit value scala.language.implicitConversions visible.
  implicit def fromShape(shape: org.apache.mxnet.Shape): Shape = new Shape(shape)
               ^
./core/src/main/scala/org/apache/mxnet/javaapi/Shape.scala:51: warning: implicit conversion method toShape should be enabled
by making the implicit value scala.language.implicitConversions visible.
  implicit def toShape(jShape: Shape): org.apache.mxnet.Shape = jShape.shape
               ^
./core/src/main/scala/org/apache/mxnet/javaapi/IO.scala:29: warning: implicit conversion method fromDataDesc should be enabled
by making the implicit value scala.language.implicitConversions visible.
  implicit def fromDataDesc(dDesc: org.apache.mxnet.DataDesc): DataDesc = new DataDesc(dDesc)
               ^
./core/src/main/scala/org/apache/mxnet/javaapi/IO.scala:31: warning: implicit conversion method toDataDesc should be enabled
by making the implicit value scala.language.implicitConversions visible.
  implicit def toDataDesc(dataDesc: DataDesc): org.apache.mxnet.DataDesc = dataDesc.dataDesc
               ^
./core/src/main/scala/org/apache/mxnet/javaapi/Context.scala:38: warning: implicit conversion method fromContext should be enabled
by making the implicit value scala.language.implicitConversions visible.
  implicit def fromContext(context: org.apache.mxnet.Context): Context = new Context(context)
               ^
./core/src/main/scala/org/apache/mxnet/javaapi/Context.scala:39: warning: implicit conversion method toContext should be enabled
by making the implicit value scala.language.implicitConversions visible.
  implicit def toContext(jContext: Context): org.apache.mxnet.Context = jContext.context
               ^
./core/src/main/scala/org/apache/mxnet/KVStore.scala:289: warning: postfix operator != should be enabled
by making the implicit value scala.language.postfixOps visible.
        val bArray = Stream.continually (bis.read).takeWhile (- 1 !=).map (_.toByte).toArray
                                                                  ^
./core/src/main/scala/org/apache/mxnet/io/MXDataIter.scala:161: warning: @deprecated now takes two arguments; see the scaladoc.
  @deprecated
   ^
./core/src/main/scala/org/apache/mxnet/io/MXDataIter.scala:165: warning: @deprecated now takes two arguments; see the scaladoc.
  @deprecated
   ^
./core/src/main/scala/org/apache/mxnet/io/ResizeIter.scala:137: warning: @deprecated now takes two arguments; see the scaladoc.
  @deprecated
   ^
./core/src/main/scala/org/apache/mxnet/io/ResizeIter.scala:143: warning: @deprecated now takes two arguments; see the scaladoc.
  @deprecated
   ^
./core/src/main/scala/org/apache/mxnet/io/PrefetchingIter.scala:181: warning: @deprecated now takes two arguments; see the scaladoc.
  @deprecated
   ^
./core/src/main/scala/org/apache/mxnet/io/PrefetchingIter.scala:185: warning: @deprecated now takes two arguments; see the scaladoc.
  @deprecated
   ^
./core/src/main/scala/org/apache/mxnet/io/NDArrayIter.scala:240: warning: @deprecated now takes two arguments; see the scaladoc.
  @deprecated
   ^
./core/src/main/scala/org/apache/mxnet/io/NDArrayIter.scala:244: warning: @deprecated now takes two arguments; see the scaladoc.
  @deprecated
   ^
./core/src/main/scala/org/apache/mxnet/NDArray.scala:36: warning: implicit conversion method getFirstResult should be enabled
by making the implicit value scala.language.implicitConversions visible.
  implicit def getFirstResult(ret: NDArrayFuncReturn): NDArray = ret(0)
               ^
./core/src/main/scala/org/apache/mxnet/NDArray.scala:1047: warning: implicit conversion method int2Scalar should be enabled
by making the implicit value scala.language.implicitConversions visible.
  implicit def int2Scalar(x: Int): NDArrayConversions = new NDArrayConversions(x.toFloat)
               ^
./core/src/main/scala/org/apache/mxnet/NDArray.scala:1048: warning: implicit conversion method double2Scalar should be enabled
by making the implicit value scala.language.implicitConversions visible.
  implicit def double2Scalar(x: Double): NDArrayConversions = new NDArrayConversions(x.toFloat)
               ^
./core/src/main/scala/org/apache/mxnet/NDArray.scala:1049: warning: implicit conversion method float2Scalar should be enabled
by making the implicit value scala.language.implicitConversions visible.
  implicit def float2Scalar(x: Float): NDArrayConversions = new NDArrayConversions(x)
               ^
./core/src/main/scala/org/apache/mxnet/Symbol.scala:1291: warning: implicit conversion method int2Scalar should be enabled
by making the implicit value scala.language.implicitConversions visible.
  implicit def int2Scalar(x: Int): SymbolConversions[Int] = new SymbolConversions(x)
               ^
./core/src/main/scala/org/apache/mxnet/Symbol.scala:1292: warning: implicit conversion method double2Scalar should be enabled
by making the implicit value scala.language.implicitConversions visible.
  implicit def double2Scalar(x: Double): SymbolConversions[Double] = new SymbolConversions(x)
               ^
./core/src/main/scala/org/apache/mxnet/Symbol.scala:1293: warning: implicit conversion method float2Scalar should be enabled
by making the implicit value scala.language.implicitConversions visible.
  implicit def float2Scalar(x: Float): SymbolConversions[Float] = new SymbolConversions(x)
               ^
./core/src/main/scala/org/apache/mxnet/Optimizer.scala:147: warning: @deprecated now takes two arguments; see the scaladoc.
  @deprecated("Use setLrMult instead.")
   ^
./core/src/main/scala/org/apache/mxnet/Context.scala:35: warning: implicit conversion method ctx2Array should be enabled
by making the implicit value scala.language.implicitConversions visible.
  implicit def ctx2Array(ctx: Context): Array[Context] = Array(ctx)
               ^
model contains 139 documentable templates
./core/src/main/scala/org/apache/mxnet/ResourceScope.scala:29: warning: Could not find any member to link for "NativeResource".
/**
^
./core/src/main/scala/org/apache/mxnet/module/BaseModule.scala:368: warning: Could not find any member to link for "IOException".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/module/BucketingModule.scala:362: warning: Could not find any member to link for "grad1_dev1,".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/module/BucketingModule.scala:338: warning: Could not find any member to link for "out1_dev1,".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/module/BaseModule.scala:206: warning: Could not find any member to link for "out1_batch1,".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/module/Module.scala:509: warning: Could not find any member to link for "grad1_dev1,".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/module/Module.scala:485: warning: Could not find any member to link for "out1_dev1,".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/module/SequentialModule.scala:369: warning: Could not find any member to link for "grad1_dev1,".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/module/SequentialModule.scala:345: warning: Could not find any member to link for "out1_dev1,".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/module/DataParallelExecutorGroup.scala:538: warning: Could not find any member to link for "grad1_dev1,".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/module/DataParallelExecutorGroup.scala:516: warning: Could not find any member to link for "out1_dev1,".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/module/BaseModule.scala:518: warning: Could not find any member to link for "grad1_dev1,".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/module/BaseModule.scala:500: warning: Could not find any member to link for "out1_dev1,".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/SymbolAPIBase.scala:1541: warning: Could not find any member to link for "batch_index,".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/ResourceScope.scala:45: warning: Could not find any member to link for "NativeResource".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/ResourceScope.scala:45: warning: Could not find any member to link for "NativeResource.close()".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/NDArrayAPIBase.scala:1541: warning: Could not find any member to link for "batch_index,".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/Executor.scala:260: warning: Could not find any member to link for "IllegalArgumentException".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/Executor.scala:248: warning: Could not find any member to link for "IllegalArgumentException".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/Executor.scala:236: warning: Could not find any member to link for "IllegalArgumentException".
  /**
  ^
./core/src/main/scala/org/apache/mxnet/Executor.scala:224: warning: Could not find any member to link for "IllegalArgumentException".
  /**
  ^
50 warnings found

[zachgk]

After progress with #13210 and #13189, the original 12 deprecation warnings, 17 feature warnings, 29 warnings, and 120 errors has been reduced to one warning. The build command and output (when not run through /docs/Makefile html) are:

ubuntu@ip-172-31-68-239:~/incubator-mxnet/scala-package$ scaladoc `find . -type f -name "*.scala" | egrep "\.\/core|\.\/infer" | egrep -v "Suite"` -classpath `find native -name "*.jar" | grep "target/lib/" | tr '\n' ':'`:`find macros -name "*-SNAPSHOT.jar"` -feature -deprecation
model contains 139 documentable templates
./core/src/main/scala/org/apache/mxnet/module/BaseModule.scala:368: warning: Could not find any member to link for "IOException".
  /**
  ^
one warning found

The IOException warning is because there is no javadoc page to link to for the java standard library's IOException. I believe it requires an addition of the -doc-external-doc flag to the scaladoc command, but I was unable to get it working. I am leaving this issue open to fix the remaining warning.

[piyushghai]

Hi @zachgk , that's an impressive improvement in the reduction in build warnings.
Did you have a chance to revisit the build warnings to prune the list even further ?

[zachgk]

I haven't. In fact, believe the list of warnings has actually grown due to contributors not checking the scala docs warnings buried in the maven output. For the IOException warning that I did not fix above, it would require specific attention to fix

[zachgk]

At some point, I found a JIRA bug within the scaladoc that explains why the -doc-external-doc flag is not resolving the warning. It was not fixed until a later version of the compiler so this issue requires upgrading the scala compiler past 2.11.8 to fix IOException.