Rename piecewise module to SRM for clarity

Parietal-INRIA · Jan 19, 2024 · db2a760 · db2a760
1 parent 01d8de1
commit db2a760
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/fmralign/piecewise.py → fmralign/srm.py b/fmralign/piecewise.py → fmralign/srm.py
@@ -136,11 +136,11 @@ def fit_one_parcellation(
     verbose,
 ):
     """Create parcellation of n_pieces and align one piece i in group source
-    data piece_X_list, using SRM alignment instance.
+    data X_list, using SRM alignment instance.
 
     Parameters
     ----------
-    X_: Niimg-like object
+    X_list: Iterable of Niimg-like objects
         Source data
     srm : FastSRM instance
     masker: instance of NiftiMasker or MultiNiftiMasker

diff --git a/fmralign/tests/test_piecewise.py → fmralign/tests/test_srm.py b/fmralign/tests/test_piecewise.py → fmralign/tests/test_srm.py
@@ -5,7 +5,7 @@
 from nilearn.maskers import NiftiMasker
 from fastsrm.identifiable_srm import IdentifiableFastSRM
 
-from fmralign.piecewise import PiecewiseModel, Identity
+from fmralign.srm import PiecewiseModel, Identity
 
 
 def to_niimgs(X, dim):