Skip to content

Commit

Permalink
Update of mmap_mode description (#1203)
Browse files Browse the repository at this point in the history
Co-authored-by: Olivier Grisel <[email protected]>
  • Loading branch information
drfraser and ogrisel committed Sep 13, 2021
1 parent 1384882 commit 9c6cc4c
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions joblib/parallel.py
Original file line number Diff line number Diff line change
Expand Up @@ -513,9 +513,11 @@ class Parallel(Logger):
in Bytes, or a human-readable string, e.g., '1M' for 1 megabyte.
Use None to disable memmapping of large arrays.
Only active when backend="loky" or "multiprocessing".
mmap_mode: {None, 'r+', 'r', 'w+', 'c'}
Memmapping mode for numpy arrays passed to workers.
See 'max_nbytes' parameter documentation for more details.
mmap_mode: {None, 'r+', 'r', 'w+', 'c'}, default: 'r'
Memmapping mode for numpy arrays passed to workers. None will
disable memmapping, other modes defined in the numpy.memmap doc:
https://numpy.org/doc/stable/reference/generated/numpy.memmap.html
Also, see 'max_nbytes' parameter documentation for more details.
Notes
-----
Expand Down

0 comments on commit 9c6cc4c

Please sign in to comment.