From 9c6cc4c260ef7b14ecbf3d59ea4d2b9e82db56e7 Mon Sep 17 00:00:00 2001 From: Douglas Fraser Date: Mon, 13 Sep 2021 10:14:29 +0100 Subject: [PATCH] Update of mmap_mode description (#1203) Co-authored-by: Olivier Grisel --- joblib/parallel.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/joblib/parallel.py b/joblib/parallel.py index 17a9f2313..687557eb6 100644 --- a/joblib/parallel.py +++ b/joblib/parallel.py @@ -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 -----