[mlpack-svn] [MLPACK] #201: bibtex citations in documentation, or regular citations?
MLPACK Trac
trac at coffeetalk-1.cc.gatech.edu
Sat Feb 4 20:14:12 EST 2012
#201: bibtex citations in documentation, or regular citations?
--------------------------------------------+-------------------------------
Reporter: rcurtin | Owner:
Type: wishlist | Status: new
Priority: trivial | Milestone: mlpack 1.0.1
Component: mlpack | Resolution:
Keywords: citation bibtex documentation | Blocking:
Blocked By: |
--------------------------------------------+-------------------------------
Comment (by niche):
I agree with this pram user guy (I was talking about doxygen-generated
documentation in my previous comments). I don't see the point of having
citations in -h. I feel that -h should have minimal output mainly for the
purpose of reminding the user how to specify certain options, but without
detailed explanations of what the options mean. For example, for the SVM C
parameter, -h might mention C controls the amount of regularization, but
it can leave out the precise mathematical form of the regularization and
leave out a reference to the precise stuff (if the user wants that, go to
the Doxygen, which probably shows the optimization problem and has a
reference).
--
Ticket URL: <http://trac.research.cc.gatech.edu/fastlab/ticket/201#comment:6>
MLPACK <www.fast-lab.org>
MLPACK is an intuitive, fast, and scalable C++ machine learning library developed by the FASTLAB at Georgia Tech under Dr. Alex Gray.
More information about the mlpack-svn
mailing list