solver.hpp: add \briefs

starsnet83 · Sep 3, 2014 · 4572663 · 4572663
1 parent 19cf385
commit 4572663
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/include/caffe/solver.hpp b/include/caffe/solver.hpp
@@ -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: