dummy docs

bdpedigo · Dec 2, 2020 · 4a4697c · 4a4697c
1 parent 9456e93
commit 4a4697c
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -13,6 +13,7 @@ Contents:
 
    installation
    usage
+   reference/index
    contributing
    authors
    history

diff --git a/docs/reference/index.rst b/docs/reference/index.rst
@@ -0,0 +1,5 @@
+.. toctree::
+   :maxdepth: 2
+
+   decomposition
+   utils
diff --git a/sparse_decomposition/decomposition/decomposition.py b/sparse_decomposition/decomposition/decomposition.py
@@ -50,6 +50,25 @@ def __init__(
         tol=1e-5,
         verbose=0,
     ):
+        """[summary]
+
+        Parameters
+        ----------
+        n_components : int, optional
+            [description], by default 2
+        gamma : [type], optional
+            [description], by default None
+        max_iter : int, optional
+            [description], by default 10
+        scale : bool, optional
+            [description], by default False
+        center : bool, optional
+            [description], by default False
+        tol : [type], optional
+            [description], by default 1e-5
+        verbose : int, optional
+            [description], by default 0
+        """
         self.n_components = n_components
         self.gamma = gamma
         self.max_iter = max_iter
@@ -82,6 +101,20 @@ def _preprocess_data(self, X):
     # TODO better convergence criteria
 
     def fit_transform(self, X, y=None):
+        """[summary]
+
+        Parameters
+        ----------
+        X : [type]
+            [description]
+        y : [type], optional
+            [description], by default None
+
+        Returns
+        -------
+        [type]
+            [description]
+        """
         self._validate_parameters(X)
 
         self._validate_data(X, copy=True, ensure_2d=True)  # from sklearn BaseEstimator