breeze.optimize

LBFGS

class LBFGS[T] extends FirstOrderMinimizer[T, DiffFunction[T]] with SerializableLogging

Port of LBFGS to Scala.

Special note for LBFGS: If you use it in published work, you must cite one of: * J. Nocedal. Updating Quasi-Newton Matrices with Limited Storage (1980), Mathematics of Computation 35, pp. 773-782. * D.C. Liu and J. Nocedal. On the Limited mem Method for Large Scale Optimization (1989), Mathematical Programming B, 45, 3, pp. 503-528. *

Linear Supertypes
FirstOrderMinimizer[T, DiffFunction[T]], SerializableLogging, Serializable, Serializable, Minimizer[T, DiffFunction[T]], AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. LBFGS
  2. FirstOrderMinimizer
  3. SerializableLogging
  4. Serializable
  5. Serializable
  6. Minimizer
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LBFGS(maxIter: Int = 1, m: Int = 10, tolerance: Double = 1E-9)(implicit space: MutableInnerProductModule[T, Double])

Type Members

  1. type History = ApproximateInverseHessian[T]

    Any history the derived minimization function needs to do its updates.

    Any history the derived minimization function needs to do its updates. typically an approximation to the second derivative/hessian matrix.

    Definition Classes
    LBFGSFirstOrderMinimizer
  2. case class State(x: T, value: Double, grad: T, adjustedValue: Double, adjustedGradient: T, iter: Int, initialAdjVal: Double, history: History, fVals: IndexedSeq[Double] = Vector(Double.PositiveInfinity), numImprovementFailures: Int = 0, searchFailed: Boolean = false) extends Product with Serializable

    Tracks the information about the optimizer, including the current point, its value, gradient, and then any history.

    Tracks the information about the optimizer, including the current point, its value, gradient, and then any history. Also includes information for checking convergence.

    x

    the current point being considered

    value

    f(x)

    grad

    f.gradientAt(x)

    adjustedValue

    f(x) + r(x), where r is any regularization added to the objective. For LBFGS, this is f(x).

    adjustedGradient

    f'(x) + r'(x), where r is any regularization added to the objective. For LBFGS, this is f'(x).

    iter

    what iteration number we are on.

    initialAdjVal

    f(x_0) + r(x_0), used for checking convergence

    history

    any information needed by the optimizer to do updates.

    fVals

    the sequence of the last minImprovementWindow values, used for checking if the "value" isn't improving

    numImprovementFailures

    the number of times in a row the objective hasn't improved, mostly for SGD

    searchFailed

    did the line search fail?

    Definition Classes
    FirstOrderMinimizer

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. def adjust(newX: T, newGrad: T, newVal: Double): (Double, T)

    Attributes
    protected
    Definition Classes
    FirstOrderMinimizer
  5. def adjustFunction(f: DiffFunction[T]): DiffFunction[T]

    Attributes
    protected
    Definition Classes
    LBFGSFirstOrderMinimizer
  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  7. def calculateObjective(f: DiffFunction[T], x: T, history: History): (Double, T)

    Attributes
    protected
    Definition Classes
    FirstOrderMinimizer
  8. def chooseDescentDirection(state: State, fn: DiffFunction[T]): T

    Attributes
    protected
    Definition Classes
    LBFGSFirstOrderMinimizer
  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def determineStepSize(state: State, f: DiffFunction[T], dir: T): Double

    Given a direction, perform a line search to find a direction to descend.

    Given a direction, perform a line search to find a direction to descend. At the moment, this just executes backtracking, so it does not fulfill the wolfe conditions.

    state

    the current state

    f

    The objective

    dir

    The step direction

    returns

    stepSize

    Attributes
    protected
    Definition Classes
    LBFGSFirstOrderMinimizer
  11. final def eq(arg0: AnyRef): Boolean

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

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

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  14. final def getClass(): Class[_]

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

    Definition Classes
    AnyRef → Any
  16. def infiniteIterations(f: DiffFunction[T], state: State): Iterator[State]

    Definition Classes
    FirstOrderMinimizer
  17. def initialHistory(f: DiffFunction[T], x: T): History

    Attributes
    protected
    Definition Classes
    LBFGSFirstOrderMinimizer
  18. def initialState(f: DiffFunction[T], init: T): State

    Attributes
    protected
    Definition Classes
    FirstOrderMinimizer
  19. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  20. def iterations(f: DiffFunction[T], init: T): Iterator[State]

    Definition Classes
    FirstOrderMinimizer
  21. def logger: LazyLogger

    Attributes
    protected
    Definition Classes
    SerializableLogging
  22. val minImprovementWindow: Int

    How many iterations to improve function by at least improvementTol

    How many iterations to improve function by at least improvementTol

    Definition Classes
    FirstOrderMinimizer
  23. def minimize(f: DiffFunction[T], init: T): T

    Definition Classes
    FirstOrderMinimizerMinimizer
  24. def minimizeAndReturnState(f: DiffFunction[T], init: T): State

    Definition Classes
    FirstOrderMinimizer
  25. final def ne(arg0: AnyRef): Boolean

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

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

    Definition Classes
    AnyRef
  28. val numberOfImprovementFailures: Int

    Definition Classes
    FirstOrderMinimizer
  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  30. def takeStep(state: State, dir: T, stepSize: Double): T

    Attributes
    protected
    Definition Classes
    LBFGSFirstOrderMinimizer
  31. def toString(): String

    Definition Classes
    AnyRef → Any
  32. def updateFValWindow(oldState: State, newAdjVal: Double): IndexedSeq[Double]

    Attributes
    protected
    Definition Classes
    FirstOrderMinimizer
  33. def updateHistory(newX: T, newGrad: T, newVal: Double, f: DiffFunction[T], oldState: State): History

    Attributes
    protected
    Definition Classes
    LBFGSFirstOrderMinimizer
  34. final def wait(): Unit

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

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from FirstOrderMinimizer[T, DiffFunction[T]]

Inherited from SerializableLogging

Inherited from Serializable

Inherited from Serializable

Inherited from Minimizer[T, DiffFunction[T]]

Inherited from AnyRef

Inherited from Any

Ungrouped