Skip to content

Add extra check in fix_job_kwargs #2829

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
alejoe91 merged 4 commits into from
May 10, 2024
Merged

Add extra check in fix_job_kwargs #2829

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
971140d
check for float > 0 for n_jobs
zm711 May 10, 2024
1738737
two more instances of preventing problem with float
zm711 May 10, 2024
57974f4
simplify if-else
zm711 May 10, 2024
7c41dba
update test error on 0 and handle float
zm711 May 10, 2024
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
13 changes: 10 additions & 3 deletions src/spikeinterface/core/job_tools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,18 @@ def fix_job_kwargs(runtime_job_kwargs):

# if n_jobs is -1, set to os.cpu_count() (n_jobs is always in global job_kwargs)
n_jobs = job_kwargs["n_jobs"]
assert isinstance(n_jobs, (float, np.integer, int))
if isinstance(n_jobs, float):
assert isinstance(n_jobs, (float, np.integer, int)) and n_jobs != 0, "n_jobs must be a non-zero int or float"

# for a fraction we do fraction of total cores
if isinstance(n_jobs, float) and 0 < n_jobs <= 1:
n_jobs = int(n_jobs * os.cpu_count())
# for negative numbers we count down from total cores (with -1 being all)
elif n_jobs < 0:
n_jobs = os.cpu_count() + 1 + n_jobs
n_jobs = int(os.cpu_count() + 1 + n_jobs)
# otherwise we just take the value given
else:
n_jobs = int(n_jobs)

job_kwargs["n_jobs"] = max(n_jobs, 1)

return job_kwargs
Expand Down
6 changes: 3 additions & 3 deletions src/spikeinterface/core/tests/test_job_tools.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,10 +180,10 @@ def test_fix_job_kwargs():
else:
assert fixed_job_kwargs["n_jobs"] == 1

# test minimum n_jobs
job_kwargs = dict(n_jobs=0, progress_bar=False, chunk_duration="1s")
# test float value > 1 is cast to correct int
job_kwargs = dict(n_jobs=4.0, progress_bar=False, chunk_duration="1s")
fixed_job_kwargs = fix_job_kwargs(job_kwargs)
assert fixed_job_kwargs["n_jobs"] == 1
assert fixed_job_kwargs["n_jobs"] == 4

# test wrong keys
with pytest.raises(AssertionError):
Expand Down