add note that fit() does nothing

AllenInstitute · Nov 20, 2017 · dd2b59b · dd2b59b
1 parent 51d1796
commit dd2b59b
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/neuroglia/nwb.py b/neuroglia/nwb.py
@@ -25,6 +25,13 @@ class SpikeTablizer(BaseEstimator,TransformerMixin):
 
     neuroglia.spike.Smoother
     neuroglia.spike.Binner
+
+    Notes
+    -----
+
+    This estimator is stateless (besides constructor parameters), the
+    fit method does nothing but is useful when used in a pipeline.
+
     """
     def __init__(self):
         pass

diff --git a/neuroglia/spike.py b/neuroglia/spike.py
@@ -42,6 +42,13 @@ class Binner(BaseEstimator,TransformerMixin):
     neuroglia.spike.Smoother
     neuroglia.nwb.SpikeTablizer
 
+
+    Notes
+    -----
+
+    This estimator is stateless (besides constructor parameters), the
+    fit method does nothing but is useful when used in a pipeline.
+
     """
     def __init__(self,sample_times):
         self.sample_times = sample_times
@@ -131,6 +138,12 @@ class Smoother(BaseEstimator,TransformerMixin):
     neuroglia.spike.Binner
     neuroglia.nwb.SpikeTablizer
 
+    Notes
+    -----
+
+    This estimator is stateless (besides constructor parameters), the
+    fit method does nothing but is useful when used in a pipeline.
+    
     """
     def __init__(self,sample_times,kernel='gaussian',tau=DEFAULT_TAU):