Class/Object

com.intel.analytics.bigdl.optim

Optimizer

Related Docs: object Optimizer | package optim

Permalink

abstract class Optimizer[T, D] extends AnyRef

Optimizer is an abstract class which is used to train a model automatically with some certain optimization algorithms.

T

numeric type, which can be Float or Double

D

the type of elements in DataSet, such as MiniBatch

Linear Supertypes
AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Optimizer
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Optimizer(model: Module[T], dataset: DataSet[D], criterion: Criterion[T])(implicit arg0: ClassTag[T], ev: TensorNumeric[T])

    Permalink

    model

    the model to be trained

    dataset

    the data set used to train a model

    criterion

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

Abstract Value Members

  1. abstract def optimize(): Module[T]

    Permalink

    Trigger the optimization process

    Trigger the optimization process

    returns

    the model to be trained

Concrete 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
  6. var checkpointPath: Option[String]

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

    Permalink
    Attributes
    protected
  8. def clone(): AnyRef

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

    Permalink
    Attributes
    protected
  10. 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
  11. val dataset: DataSet[D]

    Permalink

    the data set used to train a model

    the data set used to train a model

    Attributes
    protected
  12. var dropPercentage: Double

    Permalink
    Attributes
    protected
  13. var endWhen: Trigger

    Permalink
    Attributes
    protected
  14. final def eq(arg0: AnyRef): Boolean

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

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

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

    Permalink

    Get the directory of saving checkpoint

  18. final def getClass(): Class[_]

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

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

    Permalink
    Definition Classes
    Any
  21. var isOverWrite: Boolean

    Permalink
    Attributes
    protected
  22. var maxDropPercentage: Double

    Permalink
    Attributes
    protected
  23. var model: Module[T]

    Permalink

    the model to be trained

    the model to be trained

    Attributes
    protected
  24. final def ne(arg0: AnyRef): Boolean

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

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

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

    Permalink
    Attributes
    protected
  28. def overWriteCheckpoint(): Optimizer.this.type

    Permalink

    Enable overwrite saving checkpoint

  29. def prepareInput(): Unit

    Permalink
  30. def setCheckpoint(path: String, trigger: Trigger): Optimizer.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

  31. def setDropMoudleProperty(dropPercentage: Double, maxDropPercentage: Double, batchsize: Int = 100, warmupIteration: Int = 200): Optimizer.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

  32. def setEndWhen(endWhen: Trigger): Optimizer.this.type

    Permalink

    When to stop, passed in a Trigger

    When to stop, passed in a Trigger

    endWhen

    when to end

    returns

    the optimizer

  33. def setModel(newModel: Module[T]): Optimizer.this.type

    Permalink

    Set a model to the optimizer

    Set a model to the optimizer

    newModel

    new model

  34. def setOptimMethod(method: OptimMethod[T]): Optimizer.this.type

    Permalink

    Set an optimization method

    Set an optimization method

    method

    optimization method

  35. def setState(state: Table): Optimizer.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

  36. def setTrainSummary(trainSummary: TrainSummary): Optimizer.this.type

    Permalink

    Enable train summary.

  37. def setValidation(trigger: Trigger, sampleRDD: RDD[Sample[T]], vMethods: Array[ValidationMethod[T]], batchSize: Int): Optimizer.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

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

  39. def setValidationSummary(validationSummary: ValidationSummary): Optimizer.this.type

    Permalink

    Enable validation summary.

  40. var state: Table

    Permalink
    Attributes
    protected
  41. final def synchronized[T0](arg0: ⇒ T0): T0

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

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

    Permalink
    Attributes
    protected
  44. var validationDataSet: Option[DataSet[MiniBatch[T]]]

    Permalink
    Attributes
    protected
  45. var validationMethods: Option[Array[ValidationMethod[T]]]

    Permalink
    Attributes
    protected
  46. var validationSummary: Option[ValidationSummary]

    Permalink
    Attributes
    protected
  47. var validationTrigger: Option[Trigger]

    Permalink
    Attributes
    protected
  48. final def wait(): Unit

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

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

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

    Permalink
    Attributes
    protected

Deprecated Value Members

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

    Permalink

    make optimizer not check the singleton model on a node

    make optimizer not check the singleton model on a node

    Annotations
    @deprecated
    Deprecated

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

Inherited from AnyRef

Inherited from Any

Ungrouped