diff --git a/src/brainiak/searchlight/searchlight.py b/src/brainiak/searchlight/searchlight.py index d54fcf53..febe9e79 100644 --- a/src/brainiak/searchlight/searchlight.py +++ b/src/brainiak/searchlight/searchlight.py @@ -426,6 +426,15 @@ def run_block_function(self, block_fn, extra_block_fn_params=None, Maximum number of processes running the block function in parallel. If None, number of available hardware threads, considering cpusets restrictions. + + Returns + ------- + + An object array with the same shape as the mask, where each voxel + contains the 3D array returned by the block function for the block + containing that voxel, with the padding removed. The array is + populated only on the root rank; on other ranks it is returned + unpopulated. """ rank = self.comm.rank