Skip to content
Merged
Changes from all commits
Commits
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
12 changes: 10 additions & 2 deletions src/spikeinterface/core/job_tools.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,21 @@
- chunk_duration : str or float or None
Chunk duration in s if float or with units if str (e.g. "1s", "500ms")
* n_jobs : int | float
Number of jobs to use. With -1 the number of jobs is the same as number of cores.
Using a float between 0 and 1 will use that fraction of the total cores.
Number of workers that will be requested during multiprocessing. Note that
the OS determines how this is distributed, but for convenience one can use
* -1 the number of workers is the same as number of cores (from os.cpu_count())
* float between 0 and 1 uses fraction of total cores (from os.cpu_count())
* progress_bar : bool
If True, a progress bar is printed
* mp_context : "fork" | "spawn" | None, default: None
Context for multiprocessing. It can be None, "fork" or "spawn".
Note that "fork" is only safely available on LINUX systems
* pool_engine : "process" | "thread", default: "process"
Whether to use a ProcessPoolExecutor or ThreadPoolExecutor for multiprocessing
* max_threads_per_worker : int | None, default: 1
Sets the limit for the number of thread per process using threadpoolctl module
Only applies in an n_jobs>1 context
If None, then no limits are applied.
"""


Expand Down
Loading