spaCy/spacy
Matthew Honnibal 1b8d560d0e
Support 'memory zones' for user memory management (#13621)
Add a context manage nlp.memory_zone(), which will begin
memory_zone() blocks on the vocab, string store, and potentially
other components.

Example usage:

```
with nlp.memory_zone():
    for text in nlp.pipe(texts):
        do_something(doc)
# do_something(doc) <-- Invalid
```

Once the memory_zone() block expires, spaCy will free any shared
resources that were allocated for the text-processing that occurred
within the memory_zone. If you create Doc objects within a memory
zone, it's invalid to access them once the memory zone is expired.

The purpose of this is that spaCy creates and stores Lexeme objects
in the Vocab that can be shared between multiple Doc objects. It also
interns strings. Normally, spaCy can't know when all Doc objects using
a Lexeme are out-of-scope, so new Lexemes accumulate in the vocab,
causing memory pressure.

Memory zones solve this problem by telling spaCy "okay none of the
documents allocated within this block will be accessed again". This
lets spaCy free all new Lexeme objects and other data that were
created during the block.

The mechanism is general, so memory_zone() context managers can be
added to other components that could benefit from them, e.g. pipeline
components.

I experimented with adding memory zone support to the tokenizer as well,
for its cache. However, this seems unnecessarily complicated. It makes
more sense to just stick a limit on the cache size. This lets spaCy
benefit from the efficiency advantage of the cache better, because
we can maintain a (bounded) cache even if only small batches of
documents are being processed.
2024-09-09 11:19:39 +02:00
..
cli Fix typos in docs (#13466) 2024-04-29 11:10:17 +02:00
displacy Fix displacy span stacking (#13068) 2023-11-02 12:02:18 +01:00
kb Update __all__ fields (#13063) 2023-10-16 10:17:47 +02:00
lang add Tibetan (#13510) 2024-09-09 11:18:03 +02:00
matcher Update __all__ fields (#13063) 2023-10-16 10:17:47 +02:00
ml TextCatParametricAttention.v1: set key transform dimensions (#13249) 2024-02-02 13:01:59 +01:00
pipeline Fix use_gold_ents behaviour for EntityLinker (#13400) 2024-04-16 12:00:22 +02:00
tests Support 'memory zones' for user memory management (#13621) 2024-09-09 11:19:39 +02:00
tokens Convert properties to decorator syntax (#13390) 2024-04-16 11:51:14 +02:00
training Convert properties to decorator syntax (#13390) 2024-04-16 11:51:14 +02:00
__init__.pxd * Seems to be working after refactor. Need to wire up more POS tag features, and wire up save/load of POS tags. 2014-10-24 02:23:42 +11:00
__init__.py Revert "Load the cli module lazily for spacy.info (#12962)" 2023-10-04 12:33:33 +02:00
__main__.py Tidy up 2020-06-22 00:45:40 +02:00
about.py Set version to 3.7.6 2024-08-20 12:16:08 +02:00
attrs.pxd ci: add cython linter (#12694) 2023-07-19 12:03:31 +02:00
attrs.pyx Add profile=False to currently unprofiled cython 2023-09-28 17:09:41 +02:00
compat.py Configure isort to use the Black profile, recursively isort the spacy module (#12721) 2023-06-14 17:48:41 +02:00
default_config_pretraining.cfg Add new parameter for saving every n epoch in pretraining (#8912) 2021-08-12 11:14:48 +02:00
default_config.cfg Support registered vectors (#12492) 2023-08-01 15:46:08 +02:00
errors.py Make Language.pipe workers exit cleanly (#13321) 2024-02-12 14:39:38 +01:00
glossary.py Configure isort to use the Black profile, recursively isort the spacy module (#12721) 2023-06-14 17:48:41 +02:00
language.py Make Language.pipe workers exit cleanly (#13321) 2024-02-12 14:39:38 +01:00
lexeme.pxd Configure isort to use the Black profile, recursively isort the spacy module (#12721) 2023-06-14 17:48:41 +02:00
lexeme.pyi Configure isort to use the Black profile, recursively isort the spacy module (#12721) 2023-06-14 17:48:41 +02:00
lexeme.pyx Convert properties to decorator syntax (#13390) 2024-04-16 11:51:14 +02:00
lookups.py Configure isort to use the Black profile, recursively isort the spacy module (#12721) 2023-06-14 17:48:41 +02:00
morphology.pxd ci: add cython linter (#12694) 2023-07-19 12:03:31 +02:00
morphology.pyx Add profile=False to currently unprofiled cython 2023-09-28 17:09:41 +02:00
parts_of_speech.pxd ci: add cython linter (#12694) 2023-07-19 12:03:31 +02:00
parts_of_speech.pyx Add profile=False to currently unprofiled cython 2023-09-28 17:09:41 +02:00
pipe_analysis.py Configure isort to use the Black profile, recursively isort the spacy module (#12721) 2023-06-14 17:48:41 +02:00
py.typed Add py.typed 2021-03-16 09:48:31 +01:00
schemas.py Merge remote-tracking branch 'upstream/master' into chore/update-develop-from-master-v3.7-1 2023-09-28 15:09:06 +02:00
scorer.py Update for numpy 2.0 deprecations (#13103) 2023-11-06 08:47:53 +01:00
strings.pxd Support 'memory zones' for user memory management (#13621) 2024-09-09 11:19:39 +02:00
strings.pyi Configure isort to use the Black profile, recursively isort the spacy module (#12721) 2023-06-14 17:48:41 +02:00
strings.pyx Support 'memory zones' for user memory management (#13621) 2024-09-09 11:19:39 +02:00
structs.pxd ci: add cython linter (#12694) 2023-07-19 12:03:31 +02:00
symbols.pxd ci: add cython linter (#12694) 2023-07-19 12:03:31 +02:00
symbols.pyx Add profile=False to currently unprofiled cython 2023-09-28 17:09:41 +02:00
tokenizer.pxd Support 'memory zones' for user memory management (#13621) 2024-09-09 11:19:39 +02:00
tokenizer.pyx Support 'memory zones' for user memory management (#13621) 2024-09-09 11:19:39 +02:00
ty.py Configure isort to use the Black profile, recursively isort the spacy module (#12721) 2023-06-14 17:48:41 +02:00
typedefs.pxd Configure isort to use the Black profile, recursively isort the spacy module (#12721) 2023-06-14 17:48:41 +02:00
typedefs.pyx Add profile=False to currently unprofiled cython 2023-09-28 17:09:41 +02:00
util.py Warn about reloading dependencies after downloading models (#13081) 2023-11-10 08:05:07 +01:00
vectors.pyx Remove profile=True from currently profiled cython 2023-09-28 17:09:41 +02:00
vocab.pxd Support 'memory zones' for user memory management (#13621) 2024-09-09 11:19:39 +02:00
vocab.pyi Support 'memory zones' for user memory management (#13621) 2024-09-09 11:19:39 +02:00
vocab.pyx Support 'memory zones' for user memory management (#13621) 2024-09-09 11:19:39 +02:00