From 887c8d014f894aaf32d8bf6a416f6668ea48cc3b Mon Sep 17 00:00:00 2001
From: Ayush <ayushchamoli8@gmail.com>
Date: Wed, 27 Feb 2019 22:05:37 +0530
Subject: [PATCH] improved documentation

---
 src/mlpack/methods/linear_svm/linear_svm.hpp | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)

diff --git a/src/mlpack/methods/linear_svm/linear_svm.hpp b/src/mlpack/methods/linear_svm/linear_svm.hpp
index b785ef1a67..639e0ad322 100644
--- a/src/mlpack/methods/linear_svm/linear_svm.hpp
+++ b/src/mlpack/methods/linear_svm/linear_svm.hpp
@@ -33,6 +33,23 @@ namespace svm {
  *
  * https://link.springer.com/content/pdf/10.1007%2FBF00994018.pdf
  *
+ * An example on how to use the interface is shown below:
+ *
+ * @code
+ * arma::mat train_data; // Training data matrix.
+ * arma::Row<size_t> labels; // Labels associated with the data.
+ * const size_t inputSize = 1000; // Size of input feature vector.
+ * const size_t numClasses = 5; // Number of classes.
+ *
+ * // Train the model using default options.
+ * LinearSVM<> lsvm(train_data, labels, inputSize, numClasses, lambda,
+ *     L_BFGS());
+ *
+ * arma::mat test_data;
+ * arma::Row<size_t> predictions;
+ * lsvm.Classify(test_data, predictions);
+ * @endcode
+ *
  * @tparam MatType Type of data matrix.
  */
 template <typename MatType = arma::mat>