org.apache.mxnet.module

Module

Related Docs: object Module | package module

class Module extends BaseModule

Module is a basic module that wrap a Symbol. It is functionally the same as the FeedForward model, except under the module API.

Linear Supertypes
BaseModule, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Module
  2. BaseModule
  3. AnyRef
  4. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Module(symbolVar: Symbol, dataNames: IndexedSeq[String] = IndexedSeq("data"), labelNames: IndexedSeq[String] = IndexedSeq("softmax_label"), contexts: Array[Context] = Context.cpu(), workLoadList: Option[IndexedSeq[Float]] = None, fixedParamNames: Option[Set[String]] = None)

    symbolVar

    : Symbol definition.

    dataNames

    Input data names.

    labelNames

    Input label names

    contexts

    Default is cpu().

    workLoadList

    Default None, indicating uniform workload.

    fixedParamNames

    Default None, indicating no network parameters are fixed.

Value Members

  1. final def !=(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  5. def backward(outGrads: Array[NDArray] = null): Unit

    Backward computation.

    Backward computation.

    outGrads

    Gradient on the outputs to be propagated back. This parameter is only needed when bind is called on outputs that are not a loss function.

    Definition Classes
    ModuleBaseModule
  6. def bind(dataShapes: IndexedSeq[DataDesc], labelShapes: Option[IndexedSeq[DataDesc]] = None, forTraining: Boolean = true, inputsNeedGrad: Boolean = false, forceRebind: Boolean = false, sharedModule: Option[BaseModule] = None, gradReq: String = "write"): Unit

    Bind the symbols to construct executors.

    Bind the symbols to construct executors. This is necessary before one can perform computation with the module.

    dataShapes

    Typically is dataIter.provideData.

    labelShapes

    Typically is data_iter.provide_label.

    forTraining

    Default is true. Whether the executors should be bind for training.

    inputsNeedGrad

    Default is false. Whether the gradients to the input data need to be computed. Typically this is not needed. But this might be needed when implementing composition of modules.

    forceRebind

    Default is false. This function does nothing if the executors are already binded. But with this true, the executors will be forced to rebind.

    sharedModule

    Default is None. This is used in bucketing. When not None, the shared module essentially corresponds to a different bucket -- a module with different symbol but with the same sets of parameters (e.g. unrolled RNNs with different lengths).

    gradReq

    Requirement for gradient accumulation (globally). Can be 'write', 'add', or 'null' (default to 'write').

    Definition Classes
    ModuleBaseModule
  7. def bind(forTraining: Boolean, inputsNeedGrad: Boolean, forceRebind: Boolean, dataShape: DataDesc*): Unit

    Bind the symbols to construct executors.

    Bind the symbols to construct executors. This is necessary before one can perform computation with the module.

    forTraining

    Default is True. Whether the executors should be bind for training.

    inputsNeedGrad

    Default is False. Whether the gradients to the input data need to be computed. Typically this is not needed. But this might be needed when implementing composition of modules.

    forceRebind

    Default is False. This function does nothing if the executors are already binded. But with this True, the executors will be forced to rebind.

    dataShape

    Typically is DataIter.provideData.

    Definition Classes
    BaseModule
    Annotations
    @varargs()
  8. def borrowOptimizer(sharedModule: Module): Unit

    Borrow optimizer from a shared module.

    Borrow optimizer from a shared module. Used in bucketing, where exactly the same optimizer (esp. kvstore) is used.

    sharedModule

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. val dataNames: IndexedSeq[String]

    Input data names.

    Input data names.

    Definition Classes
    ModuleBaseModule
  11. def dataShapes: IndexedSeq[DataDesc]

    Definition Classes
    ModuleBaseModule
  12. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def fit(trainData: DataIter, evalData: Option[DataIter] = None, numEpoch: Int = 1, fitParams: FitParams = new FitParams): Unit

    Train the module parameters.

    Train the module parameters.

    trainData
    evalData

    If not None, will be used as validation set and evaluate the performance after each epoch.

    numEpoch

    Number of epochs to run training.

    fitParams

    Extra parameters for training.

    Definition Classes
    BaseModule
  16. def forward(dataBatch: DataBatch, isTrain: Option[Boolean] = None): Unit

    Forward computation.

    Forward computation.

    dataBatch

    input data

    isTrain

    Default is None, which means is_train takes the value of for_training.

    Definition Classes
    ModuleBaseModule
  17. def forward(dataBatch: DataBatch, isTrain: Boolean): Unit

    Forward computation.

    Forward computation.

    dataBatch

    a batch of data.

    isTrain

    Whether it is for training or not.

    Definition Classes
    BaseModule
  18. def forwardBackward(dataBatch: DataBatch): Unit

    Definition Classes
    BaseModule
  19. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  20. def getInputGrads(): IndexedSeq[IndexedSeq[NDArray]]

    Get the gradients to the inputs, computed in the previous backward computation.

    Get the gradients to the inputs, computed in the previous backward computation.

    returns

    In the case when data-parallelism is used, the grads will be collected from multiple devices. The results will look like grad1_dev2], [grad2_dev1, grad2_dev2, those NDArray might live on different devices.

    Definition Classes
    ModuleBaseModule
  21. def getInputGradsMerged(): IndexedSeq[NDArray]

    Get the gradients to the inputs, computed in the previous backward computation.

    Get the gradients to the inputs, computed in the previous backward computation.

    returns

    In the case when data-parallelism is used, the grads will be merged from multiple devices, as they look like from a single executor. The results will look like [grad1, grad2]

    Definition Classes
    ModuleBaseModule
  22. def getOutputs(): IndexedSeq[IndexedSeq[NDArray]]

    Get outputs of the previous forward computation.

    Get outputs of the previous forward computation.

    returns

    In the case when data-parallelism is used, the outputs will be collected from multiple devices. The results will look like out1_dev2], [out2_dev1, out2_dev2, those NDArray might live on different devices.

    Definition Classes
    ModuleBaseModule
  23. def getOutputsMerged(): IndexedSeq[NDArray]

    Get outputs of the previous forward computation.

    Get outputs of the previous forward computation.

    returns

    In the case when data-parallelism is used, the outputs will be merged from multiple devices, as they look like from a single executor. The results will look like [out1, out2]

    Definition Classes
    ModuleBaseModule
  24. def getParams: (Map[String, NDArray], Map[String, NDArray])

    Get current parameters.

    Get current parameters. (arg_params, aux_params), each a dictionary of name to parameters (in NDArray) mapping.

    returns

    (argParams, auxParams), a pair of dictionary of name to value mapping.

    Definition Classes
    ModuleBaseModule
  25. def getSymbol: Symbol

    Definition Classes
    BaseModule
  26. def hashCode(): Int

    Definition Classes
    AnyRef → Any
  27. def initOptimizer(kvstore: String = "local", optimizer: Optimizer = new SGD(), resetOptimizer: Boolean = true, forceInit: Boolean = false): Unit

    Install and initialize optimizers.

    Install and initialize optimizers.

    kvstore
    optimizer
    resetOptimizer

    Default True, indicating whether we should set rescaleGrad & idx2name for optimizer according to executorGroup

    forceInit

    Default False, indicating whether we should force re-initializing the optimizer in the case an optimizer is already installed.

    Definition Classes
    ModuleBaseModule
  28. def initParams(initializer: Initializer = new Uniform(0.01f), argParams: Map[String, NDArray] = null, auxParams: Map[String, NDArray] = null, allowMissing: Boolean = false, forceInit: Boolean = false, allowExtra: Boolean = false): Unit

    Initialize the parameters and auxiliary states.

    Initialize the parameters and auxiliary states.

    initializer

    Called to initialize parameters if needed.

    argParams

    If not None, should be a dictionary of existing arg_params. Initialization will be copied from that.

    auxParams

    If not None, should be a dictionary of existing aux_params. Initialization will be copied from that.

    allowMissing

    If true, params could contain missing values, and the initializer will be called to fill those missing params.

    forceInit

    If true, will force re-initialize even if already initialized.

    allowExtra

    Whether allow extra parameters that are not needed by symbol. If this is True, no error will be thrown when argParams or auxParams contain extra parameters that is not needed by the executor.

    Definition Classes
    ModuleBaseModule
  29. def installMonitor(monitor: Monitor): Unit

    Definition Classes
    ModuleBaseModule
  30. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  31. def labelShapes: IndexedSeq[DataDesc]

    A list of (name, shape) pairs specifying the label inputs to this module.

    A list of (name, shape) pairs specifying the label inputs to this module. If this module does not accept labels -- either it is a module without loss function, or it is not binded for training, then this should return an empty list [].

    Definition Classes
    ModuleBaseModule
  32. def loadOptimizerStates(fname: String): Unit

    Load optimizer (updater) state from file

    Load optimizer (updater) state from file

    fname

    Path to input states file.

  33. def loadParams(fname: String): Unit

    Load model parameters from file.

    Load model parameters from file.

    fname

    Path to input param file.

    Definition Classes
    BaseModule
    Annotations
    @throws( classOf[IOException] )
    Exceptions thrown

    IOException if param file is invalid

  34. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  35. final def notify(): Unit

    Definition Classes
    AnyRef
  36. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  37. def outputNames: IndexedSeq[String]

    Definition Classes
    ModuleBaseModule
  38. def outputShapes: IndexedSeq[(String, Shape)]

    Definition Classes
    ModuleBaseModule
  39. def predict(evalData: DataIter, numBatch: Int = 1, reset: Boolean = true): IndexedSeq[NDArray]

    Run prediction and collect the outputs.

    Run prediction and collect the outputs.

    evalData
    numBatch

    Default is -1, indicating running all the batches in the data iterator.

    reset

    Default is True, indicating whether we should reset the data iter before start doing prediction.

    returns

    The return value will be a list [out1, out2, out3]. Where each element is concatenation of the outputs for all the mini-batches.

    Definition Classes
    BaseModule
  40. def predict(batch: DataBatch): IndexedSeq[NDArray]

    Definition Classes
    BaseModule
  41. def predictEveryBatch(evalData: DataIter, numBatch: Int = 1, reset: Boolean = true): IndexedSeq[IndexedSeq[NDArray]]

    Run prediction and collect the outputs.

    Run prediction and collect the outputs.

    evalData
    numBatch

    Default is -1, indicating running all the batches in the data iterator.

    reset

    Default is True, indicating whether we should reset the data iter before start doing prediction.

    returns

    The return value will be a nested list like out2_batch1, ...], [out1_batch2, out2_batch2, ... This mode is useful because in some cases (e.g. bucketing), the module does not necessarily produce the same number of outputs.

    Definition Classes
    BaseModule
  42. def reshape(dataShapes: IndexedSeq[DataDesc], labelShapes: Option[IndexedSeq[DataDesc]] = None): Unit

    Reshapes the module for new input shapes.

    Reshapes the module for new input shapes.

    dataShapes

    Typically is dataIter.provideData.

    labelShapes

    Typically is dataIter.provideLabel.

  43. def saveCheckpoint(prefix: String, epoch: Int, saveOptStates: Boolean = false): Unit

    Save current progress to checkpoint.

    Save current progress to checkpoint. Use mx.callback.module_checkpoint as epoch_end_callback to save during training.

    prefix

    The file prefix to checkpoint to

    epoch

    The current epoch number

    saveOptStates

    Whether to save optimizer states for continue training

  44. def saveOptimizerStates(fname: String): Unit

    Save optimizer (updater) state to file

    Save optimizer (updater) state to file

    fname

    Path to output states file.

  45. def saveParams(fname: String): Unit

    Save model parameters to file.

    Save model parameters to file.

    fname

    Path to output param file.

    Definition Classes
    BaseModule
  46. def score(evalData: DataIter, evalMetric: EvalMetric, numBatch: Int = Integer.MAX_VALUE, batchEndCallback: Option[BatchEndCallback] = None, scoreEndCallback: Option[BatchEndCallback] = None, reset: Boolean = true, epoch: Int = 0): EvalMetric

    Run prediction on eval_data and evaluate the performance according to eval_metric.

    Run prediction on eval_data and evaluate the performance according to eval_metric.

    evalData

    : DataIter

    evalMetric

    : EvalMetric

    numBatch

    Number of batches to run. Default is Integer.MAX_VALUE, indicating run until the DataIter finishes.

    batchEndCallback

    Could also be a list of functions.

    reset

    Default True, indicating whether we should reset eval_data before starting evaluating.

    epoch

    Default 0. For compatibility, this will be passed to callbacks (if any). During training, this will correspond to the training epoch number.

    Definition Classes
    BaseModule
  47. def setParams(argParams: Map[String, NDArray], auxParams: Map[String, NDArray], allowMissing: Boolean = false, forceInit: Boolean = true, allowExtra: Boolean = false): Unit

    Assign parameter and aux state values.

    Assign parameter and aux state values. argParams : dict Dictionary of name to value (NDArray) mapping. auxParams : dict Dictionary of name to value (NDArray) mapping. allowMissing : bool If true, params could contain missing values, and the initializer will be called to fill those missing params. forceInit : bool If true, will force re-initialize even if already initialized. allowExtra : bool Whether allow extra parameters that are not needed by symbol. If this is True, no error will be thrown when argParams or auxParams contain extra parameters that is not needed by the executor.

    Definition Classes
    ModuleBaseModule
  48. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  49. def toString(): String

    Definition Classes
    AnyRef → Any
  50. def update(): Unit

    Definition Classes
    ModuleBaseModule
  51. def updateMetric(evalMetric: EvalMetric, labels: IndexedSeq[NDArray]): Unit

    Evaluate and accumulate evaluation metric on outputs of the last forward computation.

    Evaluate and accumulate evaluation metric on outputs of the last forward computation.

    evalMetric
    labels

    Definition Classes
    ModuleBaseModule
  52. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  53. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  54. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from BaseModule

Inherited from AnyRef

Inherited from Any

Ungrouped