8000 docs: document return value of run_block_function by erensh27 · Pull Request #607 · brainiak/brainiak · GitHub
[go: up one dir, main page]
Skip to content

docs: document return value of run_block_function #607

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
erensh27 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: document return value of run_block_function #607

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions src/brainiak/searchlight/searchlight.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
0