From dff6f71b2185b6341bddbd0732a2833cfd953202 Mon Sep 17 00:00:00 2001 From: Gertjan van den Burg Date: Mon, 8 Jan 2018 19:38:22 +0100 Subject: add documentation for kernels in GenSVM --- gensvm/core.py | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) (limited to 'gensvm') diff --git a/gensvm/core.py b/gensvm/core.py index 2776ec6..9b7d093 100644 --- a/gensvm/core.py +++ b/gensvm/core.py @@ -88,13 +88,18 @@ class GenSVM(BaseEstimator, ClassifierMixin): gamma : float, optional (default='auto') Kernel parameter for the rbf, poly, and sigmoid kernel. If gamma is - 'auto' then 1/n_features will be used. + 'auto' then 1/n_features will be used. See `gensvm_kernels`_ for the + exact implementation of the kernels. coef : float, optional (default=0.0) - Kernel parameter for the poly and sigmoid kernel + Kernel parameter for the poly and sigmoid kernel. See `gensvm_kernels`_ + for the exact implementation of the kernels. + degree : float, optional (default=2.0) - Kernel parameter for the poly kernel + Kernel parameter for the poly kernel. See `gensvm_kernels`_ for the + exact implementation of the kernels. + kernel_eigen_cutoff : float, optional (default=1e-8) Cutoff point for the reduced eigendecomposition used with @@ -132,6 +137,10 @@ class GenSVM(BaseEstimator, ClassifierMixin): :class:`.GenSVMGridSearchCV`: Helper class to run an efficient grid search for GenSVM. + + .. _gensvm_kernels: + https://gensvm.readthedocs.io/en/latest/#kernels-in-gensvm + """ def __init__(self, p=1.0, lmd=1e-5, kappa=0.0, epsilon=1e-6, -- cgit v1.2.3