Package

org.apache

mxnet

Permalink

package mxnet

Visibility
  1. Public
  2. All

Type Members

  1. class Accuracy extends EvalMetric

    Permalink

    Calculate accuracy

  2. trait BatchEndCallback extends AnyRef

    Permalink
  3. class CompositeEvalMetric extends EvalMetric

    Permalink

    Manage multiple evaluation metrics.

  4. class Context extends Serializable

    Permalink

    Constructing a context which is used to specify the device and device type that will be utilized by the engine.

  5. class CustomMetric extends EvalMetric

    Permalink

    Custom evaluation metric that takes a NDArray function.

  6. abstract class CustomOp extends AnyRef

    Permalink

    Base class for operators implemented in Scala

  7. abstract class CustomOpProp extends AnyRef

    Permalink

    Base class for operator property class implemented in Scala.

    Base class for operator property class implemented in Scala. MXNET_CPU_WORKER_NTHREADS must be greater than 1 for custom op to work on CPU

  8. class DataBatch extends AnyRef

    Permalink

    class batch of data

  9. case class DataDesc(name: String, shape: Shape, dtype: DType.DType = DType.Float32, layout: String = Layout.UNDEFINED) extends Product with Serializable

    Permalink
  10. abstract class DataIter extends Iterator[DataBatch]

    Permalink

    DataIter object in mxnet.

  11. abstract class DataPack extends Iterable[DataBatch]

    Permalink

    pack of DataIter, use as Iterable class

  12. trait EpochEndCallback extends AnyRef

    Permalink
  13. abstract class EvalMetric extends AnyRef

    Permalink

    Base class of all evaluation metrics

  14. class Executor extends NativeResource

    Permalink

    Symbolic Executor component of MXNet
    WARNING: it is your responsibility to clear this object through dispose().

    Symbolic Executor component of MXNet
    WARNING: it is your responsibility to clear this object through dispose().

    See also

    Symbol.bind : to create executor

  15. class F1 extends EvalMetric

    Permalink

    Calculate the F1 score of a binary classification problem.

  16. class FactorScheduler extends LRScheduler

    Permalink

    Class for reducing learning rate in factor

    Class for reducing learning rate in factor

    Assume the weight has been updated by n times, then the learning rate will be base_lr * factor^^(floor(n/step))

  17. class FeedForward extends NativeResource

    Permalink

    Model class of MXNet for training and predicting feedforward nets.

    Model class of MXNet for training and predicting feedforward nets. This class is designed for a single-data single output supervised network.

  18. abstract class Initializer extends AnyRef

    Permalink

    Base class for Initializer.

  19. class KVStore extends NativeResource

    Permalink
  20. abstract class LRScheduler extends AnyRef

    Permalink

    Learning rate scheduler, which adaptively changes the learning rate based on the training progress.

  21. class MAE extends EvalMetric

    Permalink

    Calculate Mean Absolute Error loss

  22. class MSE extends EvalMetric

    Permalink
  23. class MXIndexedRecordIO extends MXRecordIO

    Permalink

    Scala interface for read/write RecordIO data formmat with index.

    Scala interface for read/write RecordIO data formmat with index. Support random access.

  24. trait MXKVStoreCachedStates extends AnyRef

    Permalink
  25. trait MXKVStoreUpdater extends NativeResource

    Permalink
  26. class MXNetError extends Exception

    Permalink
  27. class MXRecordIO extends AnyRef

    Permalink

    Scala interface for read/write RecordIO data format

  28. class Mixed extends Initializer

    Permalink

    Initialize the weight with mixed Initializer

  29. class Model extends AnyRef

    Permalink

    Describe the model flow

  30. class Monitor extends AnyRef

    Permalink

    Monitor outputs, weights, and gradients for debugging.

  31. class NDArray extends NativeResource

    Permalink

    NDArray object in mxnet.

    NDArray object in mxnet. NDArray is basic ndarray/Tensor like data structure in mxnet.
    NOTE: NDArray is stored in native memory. Use NDArray in a try-with-resources() construct or a [[org.apache.mxnet.ResourceScope]] in a try-with-resource to have them automatically disposed. You can explicitly control the lifetime of NDArray by calling dispose manually. Failure to do this will result in leaking native memory.

  32. abstract class NDArrayAPIBase extends AnyRef

    Permalink
  33. abstract class NDArrayBase extends AnyRef

    Permalink
  34. class NDArrayOrScalar[T] extends AnyRef

    Permalink
  35. abstract class NDArrayRandomAPIBase extends AnyRef

    Permalink
  36. class NameManager extends AnyRef

    Permalink

    NameManager to do automatic naming.

    NameManager to do automatic naming. User can also inherit this object to change naming behavior.

  37. class Normal extends Initializer

    Permalink

    Initialize the weight with normal(0, sigma)

  38. class NumpyScope extends AnyRef

    Permalink
  39. abstract class Optimizer extends Serializable

    Permalink
  40. class Perplexity extends EvalMetric

    Permalink

    Calculate perplexity.

  41. class RMSE extends EvalMetric

    Permalink

    Calculate Root Mean Squred Error loss

  42. class ResourceScope extends AutoCloseable

    Permalink

    This class manages automatically releasing of org.apache.mxnet.NativeResources

  43. class Rtc extends AnyRef

    Permalink

    This class allow you to write cuda kernel in Scala and call them with NDArray.

  44. class Shape extends Serializable

    Permalink

    Shape of NDArray or other data

  45. class SparseNDArray extends NDArray

    Permalink

    Sparse NDArray is the child class of NDArray designed to hold the Sparse format

    Sparse NDArray is the child class of NDArray designed to hold the Sparse format

    Currently, Rowsparse and CSR typed NDArray is supported. Most of the Operators will convert Sparse NDArray to dense. Basic operators like add will have optimization for sparse operattions

  46. class Symbol extends NativeResource

    Permalink

    Symbolic configuration API of mxnet.

    Symbolic configuration API of mxnet.
    WARNING: it is your responsibility to clear this object through dispose().

  47. abstract class SymbolAPIBase extends AnyRef

    Permalink
  48. abstract class SymbolBase extends AnyRef

    Permalink
  49. class SymbolConversions[V] extends AnyRef

    Permalink
  50. trait SymbolGenerator extends AnyRef

    Permalink
  51. class SymbolOrScalar[T] extends AnyRef

    Permalink
  52. abstract class SymbolRandomAPIBase extends AnyRef

    Permalink
  53. class TestUtil extends AnyRef

    Permalink
  54. class TopKAccuracy extends EvalMetric

    Permalink

    Calculate top k predictions accuracy

  55. class Uniform extends Initializer

    Permalink

    Initialize the weight with uniform [-scale, scale]

  56. trait WarnIfNotDisposed extends AnyRef

    Permalink
    Attributes
    protected
  57. class Xavier extends Initializer

    Permalink

    Initialize the weight with Xavier or similar initialization scheme.

  58. class NDArrayCollector extends AnyRef

    Permalink
    Annotations
    @deprecated
    Deprecated

    (Since version 1.5.0) Please use ResourceScope instead

Value Members

  1. object Callback

    Permalink

    Callback functions that can be used to track various status during epoch.

  2. object CheckUtils

    Permalink
  3. object Context extends Serializable

    Permalink
  4. object DType extends Enumeration

    Permalink
  5. object DataBatch

    Permalink
  6. object DataDesc extends Serializable

    Permalink
  7. object Executor

    Permalink
  8. object FeedForward

    Permalink
  9. object IO

    Permalink

    IO iterators for loading training & validation data

  10. object Image

    Permalink

    Image API of Scala package enable OpenCV feature

  11. object KVStore

    Permalink

    Key value store interface of MXNet for parameter synchronization.

  12. object KVStoreServer

    Permalink
  13. object Layout

    Permalink

    Layout definition of DataDesc N Batch size C channels H Height W Weight T sequence length undefined default value of Layout

  14. object MXRecordIO

    Permalink
  15. object MX_PRIMITIVES

    Permalink
  16. object Model

    Permalink
  17. object NDArray extends NDArrayBase

    Permalink

    NDArray Object extends from NDArrayBase for abstract function signatures Main code will be generated during compile time through Macros

    NDArray Object extends from NDArrayBase for abstract function signatures Main code will be generated during compile time through Macros

    Annotations
    @AddNDArrayFunctions( false )
  18. object NDArrayAPI extends NDArrayAPIBase

    Permalink

    typesafe NDArray API: NDArray.api._ Main code will be generated during compile time through Macros

    typesafe NDArray API: NDArray.api._ Main code will be generated during compile time through Macros

    Annotations
    @AddNDArrayAPIs( false )
  19. object NDArrayOrScalar

    Permalink
  20. object NDArrayRandomAPI extends NDArrayRandomAPIBase

    Permalink

    typesafe NDArray random module: NDArray.random._ Main code will be generated during compile time through Macros

    typesafe NDArray random module: NDArray.random._ Main code will be generated during compile time through Macros

    Annotations
    @AddNDArrayRandomAPIs( false )
  21. object NameManager

    Permalink
  22. object NumpyScope

    Permalink

    NumpyScope object provides util functions for turning on/off NumPy compatibility and checking whether NumPy compatibility has been turned on/off.

    NumpyScope object provides util functions for turning on/off NumPy compatibility and checking whether NumPy compatibility has been turned on/off. NumPy compatibility is introduced first to support zero-dim and zero-size tensors as in NumPy.

  23. object Operator

    Permalink
  24. object Optimizer extends Serializable

    Permalink
  25. object Profiler

    Permalink
  26. object Random

    Permalink

    Random Number interface of mxnet.

  27. object ResourceScope

    Permalink
  28. object Shape extends Serializable

    Permalink
  29. object SparseFormat extends Enumeration

    Permalink
  30. object SparseNDArray

    Permalink
  31. object Symbol extends SymbolBase

    Permalink

    Symbol Object extends from SymbolBase for abstract function signatures Main code will be generated during compile time through Macros

    Symbol Object extends from SymbolBase for abstract function signatures Main code will be generated during compile time through Macros

    Annotations
    @AddSymbolFunctions( false )
  32. object SymbolAPI extends SymbolAPIBase

    Permalink

    typesafe Symbol API: Symbol.api._ Main code will be generated during compile time through Macros

    typesafe Symbol API: Symbol.api._ Main code will be generated during compile time through Macros

    Annotations
    @AddSymbolAPIs( false )
  33. object SymbolConversions

    Permalink
  34. object SymbolOrScalar

    Permalink
  35. object SymbolRandomAPI extends SymbolRandomAPIBase

    Permalink

    typesafe Symbol random module: Symbol.random._ Main code will be generated during compile time through Macros

    typesafe Symbol random module: Symbol.random._ Main code will be generated during compile time through Macros

    Annotations
    @AddSymbolRandomAPIs( false )
  36. object Visualization

    Permalink
  37. package annotation

    Permalink
  38. package contrib

    Permalink
  39. package infer

    Permalink
  40. package io

    Permalink
  41. package module

    Permalink
  42. package optimizer

    Permalink
  43. package util

    Permalink

Deprecated Value Members

  1. object NDArrayCollector

    Permalink

    A collector to store NDArrays.

    A collector to store NDArrays. It provides a scope, NDArrays allocated in the scope can either

    • be disposed automatically when the code block finishes, or
    • simply be collected for future usage.
      If the return type of scope is NDArray or NDArrayFuncReturn, the collector is smart enough NOT to collect or dispose the returned NDArray.
      However in other cases, it is users' responsibility NOT to leak allocated NDArrays outside, (e.g., store to a global variable and use later, pass to another thread, etc.)
      Usage Example:
       val a = NDArray.array(Array(-1f, 0f, 1f, 2f, 3f, 4f), shape = Shape(2, 3))
       val res = NDArrayCollector.auto().withScope {
         (NDArray.relu(a) + a).toArray
       }
      
      In the case above, the intermediate NDArrays (created by NDArray.relu and +) will be disposed automatically.
      User can also decide to dispose the collected NDArrays later:
       val collector = NDArrayCollector.manual()
       val res = collector.withScope {
         (NDArray.relu(a) + a).toArray
       }
       collector.foreach(_.dispose())
      
      For Java users:
       NDArray a = NDArray.array(new float[]{-1f, 0f, 1f, 2f, 3f, 4f},
                                 Shape.create(2, 3), Context.cpu(0));
       float[] sliced = NDArrayCollector.auto().withScope(
         new scala.runtime.AbstractFunction0() {
         @Override
         public float[] apply() {
           a.slice(0, 1).toArray();
         }
       });
      
    Annotations
    @deprecated
    Deprecated

    (Since version 1.5.0) Please use ResourceScope instead

Ungrouped