From 8fee910b972d2187eab891d1ec758e039ba4f69b Mon Sep 17 00:00:00 2001
From: vene <vlad@vene.ro>
Date: Mon, 19 Sep 2011 13:20:57 +0300
Subject: [PATCH] made sparse_encode functions visible

---
 doc/modules/classes.rst                |  2 ++
 sklearn/decomposition/__init__.py      |  3 ++-
 sklearn/decomposition/dict_learning.py | 12 ++++++++++++
 3 files changed, 16 insertions(+), 1 deletion(-)

diff --git a/doc/modules/classes.rst b/doc/modules/classes.rst
index 61b17a5a12..88088ff6e7 100644
--- a/doc/modules/classes.rst
+++ b/doc/modules/classes.rst
@@ -390,6 +390,8 @@ Signal Decomposition
    decomposition.fastica
    decomposition.dict_learning
    decomposition.dict_learning_online
+   decomposition.sparse_encode
+   decomposition.sparse_encode_parallel
 
 
 Linear Discriminant Analysis
diff --git a/sklearn/decomposition/__init__.py b/sklearn/decomposition/__init__.py
index 748832041d..63c0bb1bc3 100644
--- a/sklearn/decomposition/__init__.py
+++ b/sklearn/decomposition/__init__.py
@@ -8,4 +8,5 @@ from .kernel_pca import KernelPCA
 from .sparse_pca import SparsePCA, MiniBatchSparsePCA
 from .fastica_ import FastICA, fastica
 from .dict_learning import dict_learning, dict_learning_online, \
-                           DictionaryLearning, MiniBatchDictionaryLearning
+                           DictionaryLearning, MiniBatchDictionaryLearning, \
+                           sparse_encode, sparse_encode_parallel
diff --git a/sklearn/decomposition/dict_learning.py b/sklearn/decomposition/dict_learning.py
index b8e74087b6..a4e71dda33 100644
--- a/sklearn/decomposition/dict_learning.py
+++ b/sklearn/decomposition/dict_learning.py
@@ -80,6 +80,12 @@ def sparse_encode(X, Y, gram=None, cov=None, algorithm='lasso_lars',
     -------
     code: array of shape (n_components, n_features)
         The sparse codes
+
+    See also
+    --------
+    linear_model.lars_path
+    linear_model.orthogonal_mp
+    linear_model.Lasso
     """
     alpha = float(alpha) if alpha is not None else None
     X, Y = map(np.asanyarray, (X, Y))
@@ -223,6 +229,12 @@ def sparse_encode_parallel(X, Y, gram=None, cov=None, algorithm='lasso_lars',
     -------
     code: array of shape (n_components, n_features)
         The sparse codes
+
+    See also
+    --------
+    linear_model.lars_path
+    linear_model.orthogonal_mp
+    linear_model.Lasso
     """
     n_samples, n_features = Y.shape
     n_components = X.shape[1]
-- 
GitLab