Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/torch/optim.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJJ Merelo <jjmerelo@gmail.com>2016-02-25 22:32:30 +0300
committerJJ Merelo <jjmerelo@gmail.com>2016-02-25 22:32:30 +0300
commit54763a108bf4fd0d368a85a4adf9be2f632128c9 (patch)
tree0c9a76731d5acc2bd7da04a6315ce68bc3ff0bf0
parentc4c42770c33048ef2fb31a6e10c134485b4af75e (diff)
Includes a pointer to the list of algorithms
Just to make things a bit easier to the newcomers :-)
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index 375bbd8..a0a4101 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,13 @@ where:
* `x`: the current parameter vector (a 1D `torch.Tensor`)
* `state`: a table of parameters, and state variables, dependent upon the algorithm
* `x*`: the new parameter vector that minimizes `f, x* = argmin_x f(x)`
-* `{f}`: a table of all f values, in the order they've been evaluated (for some simple algorithms, like SGD, `#f == 1`)
+* `{f}`: a table of all f values, in the order they've been evaluated
+ (for some simple algorithms, like SGD, `#f == 1`)
+
+## Available algorithms
+
+Please check [this file](doc/index.md) for the full list of
+optimization algorithms available and examples.
## Important Note