solver.hpp: add \briefs
authorJeff Donahue <jeff.donahue@gmail.com>
Sat, 30 Aug 2014 22:12:39 +0000 (15:12 -0700)
committerEvan Shelhamer <shelhamer@imaginarynumber.net>
Wed, 3 Sep 2014 17:59:25 +0000 (10:59 -0700)
include/caffe/solver.hpp

index 5a7f31b..6fd159d 100644 (file)
@@ -8,6 +8,12 @@
 
 namespace caffe {
 
+/**
+ * @brief An interface for classes that perform optimization on Net%s.
+ *
+ * Requires implementation of ComputeUpdateValue to compute a parameter update
+ * given the current state of the Net parameters.
+ */
 template <typename Dtype>
 class Solver {
  public:
@@ -57,6 +63,10 @@ class Solver {
 };
 
 
+/**
+ * @brief Optimizes the parameters of a Net using
+ *        stochastic gradient descent (SGD) with momentum.
+ */
 template <typename Dtype>
 class SGDSolver : public Solver<Dtype> {
  public: