From dff6f71b2185b6341bddbd0732a2833cfd953202 Mon Sep 17 00:00:00 2001
From: Gertjan van den Burg <gertjanvandenburg@gmail.com>
Date: Mon, 8 Jan 2018 19:38:22 +0100
Subject: add documentation for kernels in GenSVM

---
 docs/index.rst   |  8 ++++++++
 docs/kernels.rst | 22 ++++++++++++++++++++++
 2 files changed, 30 insertions(+)
 create mode 100644 docs/kernels.rst

(limited to 'docs')

diff --git a/docs/index.rst b/docs/index.rst
index 7a28f0e..6064b56 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -20,4 +20,12 @@ GenSVMGridSearchCV
 
 .. include:: ./cls_gridsearch.rst
 
+Functions
+---------
+
+.. autofunction:: gensvm.gridsearch.load_default_grid
+
+.. include:: ./kernels.rst
+
 .. include:: ../CHANGELOG.rst
+
diff --git a/docs/kernels.rst b/docs/kernels.rst
new file mode 100644
index 0000000..479b6c0
--- /dev/null
+++ b/docs/kernels.rst
@@ -0,0 +1,22 @@
+Kernels in GenSVM
+-----------------
+
+Kernels in GenSVM are implemented as follows.
+
+- Radial Basis Function (RBF):
+
+.. math::
+
+  k(x_1, x_2) = \exp(-\gamma \| x_1 - x_2 \|^2 )
+
+- Polynomial:
+
+.. math::
+
+  k(x_1, x_2) = (\gamma x_1'x_2 + coef)^{degree}
+
+- Sigmoid:
+
+.. math::
+
+  k(x_1, x_2) = \tanh(\gamma x_1'x_2 + coef)
-- 
cgit v1.2.3