Skip to content

Commit

Permalink
Update of mmap_mode description (joblib#1203)
Browse files Browse the repository at this point in the history
Co-authored-by: Olivier Grisel <[email protected]>
  • Loading branch information
2 people authored and jjerphan committed Oct 11, 2021
1 parent d4fed68 commit 5a939eb
Showing 1 changed file with 5 additions and 2 deletions.
7 changes: 5 additions & 2 deletions joblib/parallel.py
Original file line number Diff line number Diff line change
Expand Up @@ -614,12 +614,15 @@ 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'}
mmap_mode: {None, 'r+', 'r', 'w+', 'c'}, default: 'r'
Memmapping mode for numpy arrays passed to workers.
See 'max_nbytes' parameter documentation for more details.
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.
return_generator: bool
If True, calls to this instance will return a generator.
Notes
-----
Expand Down

0 comments on commit 5a939eb

Please sign in to comment.