diff options
author | Andreas Fidjeland <andreas@fidjeland.io> | 2013-12-05 23:47:15 +0400 |
---|---|---|
committer | Andreas Fidjeland <andreas@fidjeland.io> | 2013-12-05 23:47:15 +0400 |
commit | 40372a6e043f2bce905be1966f48983a2924fc2a (patch) | |
tree | 3a00c611763e8c4d17c2a8574cbba9d15180cfac /lbfgs.lua | |
parent | 6bf15e408a423b13abe81f4566bb457331581134 (diff) |
Better formatting for docstrings in REPL
* fixed line-wrap issues
* fixed nested list issues
Diffstat (limited to 'lbfgs.lua')
-rw-r--r-- | lbfgs.lua | 20 |
1 files changed, 10 insertions, 10 deletions
@@ -13,22 +13,22 @@ rate allows a reduction of confidence in the step size. ARGS: -- `opfunc` : a function that takes a single input (X), the point of +- `opfunc` : a function that takes a single input (X), the point of evaluation, and returns f(X) and df/dX -- `x` : the initial point -- `state` : a table describing the state of the optimizer; after each +- `x` : the initial point +- `state` : a table describing the state of the optimizer; after each call the state is modified - - `state.maxIter` : Maximum number of iterations allowed - - `state.maxEval` : Maximum number of function evaluations - - `state.tolFun` : Termination tolerance on the first-order optimality - - `state.tolX` : Termination tol on progress in terms of func/param changes - - `state.lineSearch` : A line search function - - `state.learningRate` : If no line search provided, then a fixed step size is used +- `state.maxIter` : Maximum number of iterations allowed +- `state.maxEval` : Maximum number of function evaluations +- `state.tolFun` : Termination tolerance on the first-order optimality +- `state.tolX` : Termination tol on progress in terms of func/param changes +- `state.lineSearch` : A line search function +- `state.learningRate` : If no line search provided, then a fixed step size is used RETURN: - `x*` : the new `x` vector, at the optimal point - `f` : a table of all function values: - `f[1]` is the value of the function before any optimization + `f[1]` is the value of the function before any optimization and `f[#f]` is the final fully optimized value, at `x*` (Clement Farabet, 2012) |