Optimizer tutorial #1244
Optimizer tutorial #1244
Conversation
There was a problem hiding this comment.
We talked about this one over email and it looks good to me. When it's merged, after a day it'll automatically be built and put on the mlpack website, so after that it's probably worth it to take a look at the tutorial and make sure everything rendered/compiled right.
doc/tutorials/tutorials.txt
Outdated
| @@ -39,6 +39,7 @@ progress to complex, extensible uses. | |||
| - \ref cftutorial | |||
| - \ref akfntutorial | |||
| - \ref cnetutorial | |||
| - \ref optimizertutorial | |||
There was a problem hiding this comment.
This might be better as part of the 'policy class documentation'? Not sure, up to you.
|
|
||
| @file optimizer.txt | ||
| @author Marcus Edel (https://kurg.org) | ||
| @brief Tutorial for how to implement a new Optimizer in mlpack. |
There was a problem hiding this comment.
I guess this should be Tutorial on instead of Tutorial for?
There was a problem hiding this comment.
Either is valid, in my opinion.
| @endcode | ||
|
|
||
| Finally, \c separable functions must implement the method \c Shuffle() function, | ||
| which shuffles the ordering of the functions |
There was a problem hiding this comment.
End of sentence punctuation (sorry if I'm being excessively concerned about grammar).
|
|
||
| @code | ||
| // Shuffel the ordering of the function. | ||
| void Shuffel(); |
| double Optimize(FunctionType& function, arma::mat& parameters); | ||
| @endcode | ||
|
|
||
| The \c Optimize() method optimize the given function \c function, and stores |
There was a problem hiding this comment.
optimizes instead of optimize?
This is basically a striped-down version of "A generic and fast C++ optimization framework".