Skip to content

Docs: Edit the argument documentation of n_jobs of the parallelize function #987

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

Merged
selmanozleyen merged 4 commits into from
May 15, 2025
Merged

Docs: Edit the argument documentation of n_jobs of the parallelize function #987

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3771a0a
edit docs
selmanozleyen Apr 9, 2025
9f2ac00
Merge branch 'scverse:main' into docs/spatial-autocorr
selmanozleyen May 6, 2025
d19c860
Update _utils.py
selmanozleyen May 7, 2025
7991dbc
update docs
selmanozleyen May 7, 2025
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
3 changes: 2 additions & 1 deletion src/squidpy/_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,8 @@ def decorator2(obj: Any) -> Any:
"""
_parallelize = """\
n_jobs
Number of parallel jobs.
Number of parallel jobs to use. If the function uses numba compiled functions, numba may
use cores depending on the number of threads set in the environment regardless of this argument.
backend
Parallelization backend to use. See :class:`joblib.Parallel` for available options.
show_progress_bar
Expand Down
3 changes: 2 additions & 1 deletion src/squidpy/_utils.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,8 @@ def parallelize(
collection
Sequence of items to split into chunks.
n_jobs
Number of parallel jobs.
Number of parallel jobs to use. If the function uses numba compiled functions, numba may
use cores depending on the number of threads set in the environment regardless of this argument.
n_split
Split ``collection`` into ``n_split`` chunks.
If <= 0, ``collection`` is assumed to be already split into chunks.
Expand Down
Loading