use raw strings in docstrings for __init__ (#169)

Author: StrikerRUS

lightning/impl/adagrad.py

@@ -48,7 +48,7 @@ def _fit(self, X, Y):
 
 
 class AdaGradClassifier(BaseClassifier, _BaseAdagrad):
-    """
+    r"""
     Estimator for learning linear classifiers by AdaGrad.
 
     Solves the following objective:
@@ -92,7 +92,7 @@ def fit(self, X, y):
 
 
 class AdaGradRegressor(BaseRegressor, _BaseAdagrad):
-    """
+    r"""
     Estimator for learning linear regressors by AdaGrad.
 
     Solves the following objective:

lightning/impl/dual_cd.py

@@ -23,7 +23,7 @@
 
 
 class LinearSVC(BaseClassifier):
-    """Estimator for learning linear support vector machine by coordinate
+    r"""Estimator for learning linear support vector machine by coordinate
     descent in the dual.
 
     Parameters
@@ -152,7 +152,7 @@ def fit(self, X, y):
 
 
 class LinearSVR(BaseRegressor):
-    """Estimator for learning a linear support vector regressor by coordinate
+    r"""Estimator for learning a linear support vector regressor by coordinate
     descent in the dual.
 
     Parameters

lightning/impl/fista.py

@@ -131,7 +131,7 @@ def _fit(self, X, y, n_vectors):
 
 
 class FistaClassifier(BaseClassifier, _BaseFista):
-    """Estimator for learning linear classifiers by FISTA.
+    r"""Estimator for learning linear classifiers by FISTA.
 
     The objective functions considered take the form
 
@@ -227,7 +227,7 @@ def fit(self, X, y):
 
 
 class FistaRegressor(BaseRegressor, _BaseFista):
-    """Estimator for learning linear classifiers by FISTA.
+    r"""Estimator for learning linear classifiers by FISTA.
 
     The objective functions considered take the form
 

lightning/impl/prank.py

@@ -26,7 +26,7 @@ def classes_(self):
 
 
 class PRank(_BasePRank):
-    """Online algorithm for learning an ordinal regression model.
+    r"""Online algorithm for learning an ordinal regression model.
 
     Parameters
     ----------
@@ -104,7 +104,7 @@ def predict(self, X):
 
 
 class KernelPRank(_BasePRank):
-    """Kernelized online algorithm for learning an ordinal regression model.
+    r"""Kernelized online algorithm for learning an ordinal regression model.
 
     Parameters
     ----------

lightning/impl/primal_cd.py

@@ -72,7 +72,7 @@ def _init_errors(self, Y):
 
 
 class CDClassifier(_BaseCD, BaseClassifier):
-    """Estimator for learning linear classifiers by (block) coordinate descent.
+    r"""Estimator for learning linear classifiers by (block) coordinate descent.
 
     The objective functions considered take the form
 
@@ -355,7 +355,7 @@ def fit(self, X, y):
 
 
 class CDRegressor(_BaseCD, BaseRegressor):
-    """Estimator for learning linear regressors by (block) coordinate descent.
+    r"""Estimator for learning linear regressors by (block) coordinate descent.
 
     The objective functions considered take the form
 

lightning/impl/primal_newton.py

@@ -24,7 +24,7 @@
 
 
 class KernelSVC(BaseClassifier):
-    """Estimator for learning kernel SVMs by Newton's method.
+    r"""Estimator for learning kernel SVMs by Newton's method.
 
     Parameters
     ----------

lightning/impl/sag.py

@@ -89,7 +89,7 @@ def _fit(self, X, Y, sample_weight):
 
 
 class SAGClassifier(BaseClassifier, _BaseSAG):
-    """
+    r"""
     Estimator for learning linear classifiers by SAG.
 
     Solves the following objective:
@@ -166,7 +166,7 @@ def fit(self, X, y, sample_weight=None):
 
 
 class SAGAClassifier(SAGClassifier):
-    """
+    r"""
     Estimator for learning linear classifiers by SAGA.
 
     Solves the following objective:
@@ -219,7 +219,7 @@ def __init__(self, eta='auto', alpha=1.0, beta=0.0, loss="smooth_hinge",
 
 
 class SAGRegressor(BaseRegressor, _BaseSAG):
-    """
+    r"""
     Estimator for learning linear regressors by SAG.
 
     Solves the following objective:
@@ -293,7 +293,7 @@ def fit(self, X, y, sample_weight=None):
 
 
 class SAGARegressor(SAGRegressor):
-    """
+    r"""
     Estimator for learning linear regressors by SAG.
 
     Solves the following objective:

lightning/impl/sdca.py

@@ -72,7 +72,7 @@ def _fit(self, X, Y):
 
 
 class SDCAClassifier(BaseClassifier, _BaseSDCA):
-    """
+    r"""
     Estimator for learning linear classifiers by (proximal) SDCA.
 
     Solves the following objective:
@@ -137,7 +137,7 @@ def fit(self, X, y):
 
 
 class SDCARegressor(BaseRegressor, _BaseSDCA):
-    """
+    r"""
     Estimator for learning linear regressors by (proximal) SDCA.
 
     Solves the following objective:

lightning/impl/sgd.py

@@ -58,7 +58,7 @@ def _get_learning_rate(self):
 
 
 class SGDClassifier(BaseClassifier, _BaseSGD):
-    """Estimator for learning linear classifiers by SGD.
+    r"""Estimator for learning linear classifiers by SGD.
 
     Parameters
     ----------
@@ -241,7 +241,7 @@ def fit(self, X, y):
 
 
 class SGDRegressor(BaseRegressor, _BaseSGD):
-    """Estimator for learning linear regressors by SGD.
+    r"""Estimator for learning linear regressors by SGD.
 
     Parameters
     ----------

lightning/impl/svrg.py

@@ -47,7 +47,7 @@ def _fit(self, X, Y):
 
 
 class SVRGClassifier(BaseClassifier, _BaseSVRG):
-    """
+    r"""
     Estimator for learning linear classifiers by SVRG.
 
     Solves the following objective:
@@ -88,7 +88,7 @@ def fit(self, X, y):
 
 
 class SVRGRegressor(BaseRegressor, _BaseSVRG):
-    """
+    r"""
     Estimator for learning linear regressors by SVRG.
 
     Solves the following objective: