Skip to content

Commit

Permalink
DOC explain Memory byte_limit behavior (#1171)
Browse files Browse the repository at this point in the history
  • Loading branch information
tomMoral committed Apr 2, 2021
1 parent 457d2c8 commit 754433f
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions joblib/memory.py
Original file line number Diff line number Diff line change
Expand Up @@ -883,8 +883,10 @@ class Memory(Logger):
bytes_limit: int, optional
Limit in bytes of the size of the cache. By default, the size of
the cache is unlimited.
Note: You need to call :meth:`joblib.Memory.reduce_size` to
the cache is unlimited. When reducing the size of the cache,
``joblib`` keeps the most recently accessed items first.
**Note:** You need to call :meth:`joblib.Memory.reduce_size` to
actually reduce the cache size to be less than ``bytes_limit``.
backend_options: dict, optional
Expand Down

0 comments on commit 754433f

Please sign in to comment.