class LocalOptimizer[T] extends Optimizer[T, MiniBatch[T]]

Optimize a model on a single machine

Linear Supertypes
Optimizer[T, MiniBatch[T]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LocalOptimizer
  2. Optimizer
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LocalOptimizer(model: Module[T], dataset: LocalDataSet[MiniBatch[T]], criterion: Criterion[T])(implicit arg0: ClassTag[T], ev: TensorNumeric[T])

    model

    model to be optimized

    dataset

    data set

    criterion

    criterion to be used

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. var checkSingleton: Boolean
    Attributes
    protected
    Definition Classes
    Optimizer
  6. var checkpointPath: Option[String]
    Attributes
    protected
    Definition Classes
    Optimizer
  7. var checkpointTrigger: Option[Trigger]
    Attributes
    protected
    Definition Classes
    Optimizer
  8. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  9. var computeThresholdbatchSize: Int
    Attributes
    protected
    Definition Classes
    Optimizer
  10. var criterion: Criterion[T]
    Attributes
    protected
    Definition Classes
    Optimizer
  11. var dataset: DataSet[MiniBatch[T]]
    Attributes
    protected
    Definition Classes
    Optimizer
  12. def disableGradientClipping(): LocalOptimizer.this.type

    Disable gradient clipping

    Disable gradient clipping

    Definition Classes
    Optimizer
  13. var dropPercentage: Double
    Attributes
    protected
    Definition Classes
    Optimizer
  14. var endWhen: Trigger
    Attributes
    protected
    Definition Classes
    Optimizer
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  17. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def getCheckpointPath(): Option[String]

    Get the directory of saving checkpoint

    Get the directory of saving checkpoint

    Definition Classes
    Optimizer
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. var isOverWrite: Boolean
    Attributes
    protected
    Definition Classes
    Optimizer
  23. var maxDropPercentage: Double
    Attributes
    protected
    Definition Classes
    Optimizer
  24. var model: Module[T]
    Attributes
    protected
    Definition Classes
    Optimizer
  25. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. var optimMethods: Map[String, OptimMethod[T]]
    Attributes
    protected
    Definition Classes
    Optimizer
  29. def optimize(): Module[T]

    Trigger the optimization process

    Trigger the optimization process

    returns

    the model to be trained

    Definition Classes
    LocalOptimizer → Optimizer
  30. def overWriteCheckpoint(): LocalOptimizer.this.type

    Enable overwrite saving checkpoint

    Enable overwrite saving checkpoint

    Definition Classes
    Optimizer
  31. var parameterProcessors: ArrayBuffer[ParameterProcessor]

    a list of ParameterProcessor, orders matter

    a list of ParameterProcessor, orders matter

    Attributes
    protected
    Definition Classes
    Optimizer
  32. def prepareInput(): Unit
    Definition Classes
    Optimizer
  33. def reserveOptim(reserve: Boolean): LocalOptimizer.this.type
    Definition Classes
    Optimizer
  34. def setCheckpoint(path: String, trigger: Trigger): LocalOptimizer.this.type

    Set a check point saved at path triggered by trigger

    Set a check point saved at path triggered by trigger

    path

    the directory to save

    trigger

    how often to save the check point

    returns

    the optimizer

    Definition Classes
    Optimizer
  35. def setConstantGradientClipping(min: Double, max: Double): LocalOptimizer.this.type

    Set constant gradient clipping

    Set constant gradient clipping

    min

    the minimum value to clip by

    max

    the maximum value to clip by

    Definition Classes
    Optimizer
  36. def setCriterion(newCriterion: Criterion[T]): LocalOptimizer.this.type

    Set a new criterion to the optimizer

    Set a new criterion to the optimizer

    newCriterion

    new criterion

    Definition Classes
    Optimizer
  37. def setDropModuleProperty(dropPercentage: Double, maxDropPercentage: Double, batchsize: Int = 100, warmupIteration: Int = 200): LocalOptimizer.this.type

    Set dropping a certain percentage (dropPercentage) of models during distributed training to accelerate, because some cached model may take too long.

    Set dropping a certain percentage (dropPercentage) of models during distributed training to accelerate, because some cached model may take too long.

    dropPercentage

    drop percentage

    maxDropPercentage

    max drop percentage

    batchsize

    batch size

    warmupIteration

    how may iteration to warm up

    returns

    this optimizer

    Definition Classes
    Optimizer
  38. def setEndWhen(endWhen: Trigger): LocalOptimizer.this.type

    When to stop, passed in a Trigger

    When to stop, passed in a Trigger

    endWhen

    when to end

    returns

    the optimizer

    Definition Classes
    Optimizer
  39. def setGradientClippingByl2Norm(l2NormThreshold: Double): LocalOptimizer.this.type

    Clip gradient to a maximum L2-norm

    Clip gradient to a maximum L2-norm

    l2NormThreshold

    gradient L2-Norm threshold

    Definition Classes
    Optimizer
  40. def setModel(newModel: Module[T]): LocalOptimizer.this.type

    Set a model to the optimizer.

    Set a model to the optimizer. Notice: if current optimMethod in this optimizer is not a global optimMethod, this setModel will throw an exception. You should use setModelAndOptimMethods instead.

    newModel

    new model

    Definition Classes
    Optimizer
  41. def setModelAndOptimMethods(newModel: Module[T], newOptimMethods: Map[String, OptimMethod[T]]): LocalOptimizer.this.type

    Set new model and new optimMethods to the optimizer.

    Set new model and new optimMethods to the optimizer.

    newModel

    new model

    newOptimMethods

    new optimMethods

    Definition Classes
    Optimizer
  42. def setOptimMethod(method: OptimMethod[T]): LocalOptimizer.this.type

    Set an optimization method

    Set an optimization method

    method

    optimization method

    Definition Classes
    Optimizer
  43. def setOptimMethods(method: Map[String, OptimMethod[T]]): LocalOptimizer.this.type

    Set optimization methods for each submodule.

    Set optimization methods for each submodule.

    method

    A mapping of submodule -> OptimMethod

    Definition Classes
    Optimizer
  44. def setState(state: Table): LocalOptimizer.this.type

    Set a state(learning rate, epochs...) to the optimizer

    Set a state(learning rate, epochs...) to the optimizer

    state

    the state to be saved

    Definition Classes
    Optimizer
  45. def setTrainData(sampleRDD: RDD[Sample[T]], batchSize: Int, featurePaddingParam: PaddingParam[T] = null, labelPaddingParam: PaddingParam[T] = null): LocalOptimizer.this.type

    Set new train dataset.

    Set new train dataset.

    sampleRDD

    training Samples

    batchSize

    mini batch size

    featurePaddingParam

    feature padding strategy, see com.intel.analytics.bigdl.dataset.PaddingParam for details.

    labelPaddingParam

    label padding strategy, see com.intel.analytics.bigdl.dataset.PaddingParam for details.

    returns

    the optimizer

    Definition Classes
    Optimizer
  46. def setTrainData(sampleRDD: RDD[Sample[T]], batchSize: Int, miniBatchImpl: MiniBatch[T]): LocalOptimizer.this.type

    Set new train dataset.

    Set new train dataset. User can supply a customized implementation of trait MiniBatch to define how data is organized and retrieved in a mini batch.

    sampleRDD

    training Samples

    batchSize

    mini batch size

    miniBatchImpl

    An User-Defined MiniBatch implementation.

    returns

    the Optimizer

    Definition Classes
    Optimizer
  47. def setTrainSummary(trainSummary: TrainSummary): LocalOptimizer.this.type

    Enable train summary.

    Enable train summary.

    Definition Classes
    Optimizer
  48. def setValidation(trigger: Trigger, sampleRDD: RDD[Sample[T]], vMethods: Array[ValidationMethod[T]], batchSize: Int, miniBatch: MiniBatch[T]): LocalOptimizer.this.type

    Set validate evaluation

    Set validate evaluation

    trigger

    how often to evaluation validation set

    sampleRDD

    validate data set in type of RDD of Sample

    vMethods

    a set of validation method ValidationMethod

    batchSize

    batch size

    miniBatch

    construct MiniBatch with a specified miniBatch type

    Definition Classes
    Optimizer
  49. def setValidation(trigger: Trigger, sampleRDD: RDD[Sample[T]], vMethods: Array[ValidationMethod[T]], batchSize: Int): LocalOptimizer.this.type

    Set a validate evaluation

    Set a validate evaluation

    trigger

    how often to evaluation validation set

    sampleRDD

    validate data set in type of RDD of Sample

    vMethods

    a set of validation method ValidationMethod

    batchSize

    batch size

    returns

    this optimizer

    Definition Classes
    Optimizer
  50. def setValidation(trigger: Trigger, sampleRDD: RDD[Sample[T]], vMethods: Array[ValidationMethod[T]], batchSize: Int, featurePaddingParam: PaddingParam[T], labelPaddingParam: PaddingParam[T]): LocalOptimizer.this.type

    Set a validate evaluation

    Set a validate evaluation

    trigger

    how often to evaluation validation set

    sampleRDD

    validate data set in type of RDD of Sample

    vMethods

    a set of validation method ValidationMethod

    batchSize

    batch size

    featurePaddingParam

    feature padding strategy, see com.intel.analytics.bigdl.dataset.PaddingParam for details.

    labelPaddingParam

    label padding strategy, see com.intel.analytics.bigdl.dataset.PaddingParam for details.

    returns

    this optimizer

    Definition Classes
    Optimizer
  51. def setValidation(trigger: Trigger, dataset: DataSet[MiniBatch[T]], vMethods: Array[ValidationMethod[T]]): LocalOptimizer.this.type

    Set a validate evaluation

    Set a validate evaluation

    trigger

    how often to evaluation validation set

    dataset

    validate data set in type of DataSet of MiniBatch

    vMethods

    a set of validation method ValidationMethod

    returns

    this optimizer

    Definition Classes
    Optimizer
  52. def setValidationSummary(validationSummary: ValidationSummary): LocalOptimizer.this.type

    Enable validation summary.

    Enable validation summary.

    Definition Classes
    Optimizer
  53. var state: Table
    Attributes
    protected
    Definition Classes
    Optimizer
  54. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  55. def toString(): String
    Definition Classes
    AnyRef → Any
  56. var trainSummary: Option[TrainSummary]
    Attributes
    protected
    Definition Classes
    Optimizer
  57. var validationDataSet: Option[DataSet[MiniBatch[T]]]
    Attributes
    protected
    Definition Classes
    Optimizer
  58. var validationMethods: Option[Array[ValidationMethod[T]]]
    Attributes
    protected
    Definition Classes
    Optimizer
  59. var validationSummary: Option[ValidationSummary]
    Attributes
    protected
    Definition Classes
    Optimizer
  60. var validationTrigger: Option[Trigger]
    Attributes
    protected
    Definition Classes
    Optimizer
  61. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  63. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  64. var warmupIterationNum: Int
    Attributes
    protected
    Definition Classes
    Optimizer

Deprecated Value Members

  1. def disableCheckSingleton(): LocalOptimizer.this.type

    make optimizer not check the singleton model on a node

    make optimizer not check the singleton model on a node

    Definition Classes
    Optimizer
    Annotations
    @deprecated
    Deprecated

    (Since version 0.1.0) Use bigdl.check.singleton instead

Inherited from Optimizer[T, MiniBatch[T]]

Inherited from AnyRef

Inherited from Any

Ungrouped