Class/Object

com.intel.analytics.bigdl.optim

DistriOptimizer

Related Docs: object DistriOptimizer | package optim

Permalink

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

The optimizer run on a distributed cluster.

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

Instance Constructors

  1. new DistriOptimizer(_model: Module[T], dataset: DistributedDataSet[MiniBatch[T]], criterion: Criterion[T])(implicit arg0: ClassTag[T], ev: TensorNumeric[T])

    Permalink

    _model

    train model

    dataset

    train dataset

    criterion

    loss function

Value Members

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

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

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

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

    Permalink
    Definition Classes
    Any
  5. var checkSingleton: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Optimizer
  6. var checkpointPath: Option[String]

    Permalink
    Attributes
    protected
    Definition Classes
    Optimizer
  7. var checkpointTrigger: Option[Trigger]

    Permalink
    Attributes
    protected
    Definition Classes
    Optimizer
  8. def clearState(): Unit

    Permalink

    Clean some internal states, so this or other optimizers can run optimize again

    Clean some internal states, so this or other optimizers can run optimize again

    This method will be called at the end of optimize. You need not call it if optimize succeed. If the optimize fails, you may call it before next optimize.

  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. var computeThresholdbatchSize: Int

    Permalink
    Attributes
    protected
    Definition Classes
    Optimizer
  11. val criterion: Criterion[T]

    Permalink

    the criterion used to evaluate the loss of the model given an input

    the criterion used to evaluate the loss of the model given an input

    Attributes
    protected
    Definition Classes
    Optimizer
  12. val dataset: DataSet[MiniBatch[T]]

    Permalink

    the data set used to train a model

    the data set used to train a model

    Attributes
    protected
    Definition Classes
    Optimizer
  13. var dropPercentage: Double

    Permalink
    Attributes
    protected
    Definition Classes
    Optimizer
  14. var endWhen: Trigger

    Permalink
    Attributes
    protected
    Definition Classes
    Optimizer
  15. final def eq(arg0: AnyRef): Boolean

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

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  18. def getCheckpointPath(): Option[String]

    Permalink

    Get the directory of saving checkpoint

    Get the directory of saving checkpoint

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

    Permalink
    Definition Classes
    AnyRef → Any
  20. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  22. var isOverWrite: Boolean

    Permalink
    Attributes
    protected
    Definition Classes
    Optimizer
  23. var maxDropPercentage: Double

    Permalink
    Attributes
    protected
    Definition Classes
    Optimizer
  24. val metrics: Metrics

    Permalink
  25. var model: Module[T]

    Permalink

    the model to be trained

    the model to be trained

    Attributes
    protected
    Definition Classes
    Optimizer
  26. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  27. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  28. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  29. var optimMethod: OptimMethod[T]

    Permalink
    Attributes
    protected
    Definition Classes
    Optimizer
  30. def optimize(): Module[T]

    Permalink

    Trigger the optimization process

    Trigger the optimization process

    returns

    the model to be trained

    Definition Classes
    DistriOptimizerOptimizer
  31. def overWriteCheckpoint(): DistriOptimizer.this.type

    Permalink

    Enable overwrite saving checkpoint

    Enable overwrite saving checkpoint

    Definition Classes
    Optimizer
  32. def prepareInput(): Unit

    Permalink
    Definition Classes
    DistriOptimizerOptimizer
  33. def setCheckpoint(path: String, trigger: Trigger): DistriOptimizer.this.type

    Permalink

    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 offten to save the check point

    returns

    the optimizer

    Definition Classes
    Optimizer
  34. def setDropMoudleProperty(dropPercentage: Double, maxDropPercentage: Double, batchsize: Int = 100, warmupIteration: Int = 200): DistriOptimizer.this.type

    Permalink

    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
  35. def setEndWhen(endWhen: Trigger): DistriOptimizer.this.type

    Permalink

    When to stop, passed in a Trigger

    When to stop, passed in a Trigger

    endWhen

    when to end

    returns

    the optimizer

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

    Permalink

    Set a model to the optimizer

    Set a model to the optimizer

    newModel

    new model

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

    Permalink

    Set an optimization method

    Set an optimization method

    method

    optimization method

    Definition Classes
    Optimizer
  38. def setState(state: Table): DistriOptimizer.this.type

    Permalink

    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
  39. def setTrainSummary(trainSummary: TrainSummary): DistriOptimizer.this.type

    Permalink

    Enable train summary.

    Enable train summary.

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

    Permalink

    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
  41. def setValidation(trigger: Trigger, dataset: DataSet[MiniBatch[T]], vMethods: Array[ValidationMethod[T]]): DistriOptimizer.this.type

    Permalink

    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
  42. def setValidationSummary(validationSummary: ValidationSummary): DistriOptimizer.this.type

    Permalink

    Enable validation summary.

    Enable validation summary.

    Definition Classes
    Optimizer
  43. var state: Table

    Permalink
    Attributes
    protected
    Definition Classes
    Optimizer
  44. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  45. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  46. var trainSummary: Option[TrainSummary]

    Permalink
    Attributes
    protected
    Definition Classes
    Optimizer
  47. var validationDataSet: Option[DataSet[MiniBatch[T]]]

    Permalink
    Attributes
    protected
    Definition Classes
    Optimizer
  48. var validationMethods: Option[Array[ValidationMethod[T]]]

    Permalink
    Attributes
    protected
    Definition Classes
    Optimizer
  49. var validationSummary: Option[ValidationSummary]

    Permalink
    Attributes
    protected
    Definition Classes
    Optimizer
  50. var validationTrigger: Option[Trigger]

    Permalink
    Attributes
    protected
    Definition Classes
    Optimizer
  51. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  54. var warmupIterationNum: Int

    Permalink
    Attributes
    protected
    Definition Classes
    Optimizer

Deprecated Value Members

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

    Permalink

    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