Skip to main content

Based on http://stackoverflow.com/questions/7323664/python-generator-pre-fetch

This is a single-function package that makes it possible to transform any generator into a BackgroundGenerator which computes any number of elements from the generator ahead, in a background thread.

It is quite lightweight, but not entirely weightless.

The BackgroundGenerator is most useful when you have a GIL releasing task which might take a long time to complete (e.g. Disk I/O, Web Requests, pure C functions, GPU processing, …), and another task which takes a similar amount of time, but is dependent on the results of the first task (e.g. Computationally intensive processing of data loaded from disk).

Normally these two tasks will constantly wait for one another to finish. If you make one of these tasks a BackgroundGenerator (see examples below), they will work in parallel, potentially saving up to 50% of execution time (definitely less in practice).

We personally use the BackgroundGenerator when iterating over minibatches of data for deep learning with tensorflow and theano ( lasagne, blocks, raw, etc.).

Quick usage example (ipython notebook) - https://github.com/justheuristic/prefetch_generator/blob/master/example.ipynb

This package contains two objects:
  • The Class BackgroundGenerator(generator [,max_prefetch=1])

  • The decorator @prefetch([max_prefetch=1])

the usage is either

#for item in BackgroundGenerator(my_generator): # do_stuff(item)

or

#@prefetch() #def my_generator(some_param): # while True: # X = read_heavy_file() # y = wget_from_cornhub() # do_pretty_much_anything(some_param) # yield X, y

More details are written in the BackgroundGenerator doc: See help(BackgroundGenerator)

Metadata

Release files for prefetch-generator 1.0.3

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for prefetch-generator 1.0.3
File Size Uploaded
prefetch_generator-1.0.3.tar.gz 4.6 kB Details

Release files / prefetch_generator-1.0.3.tar.gz

Download URL prefetch_generator-1.0.3.tar.gz
Size 4.6 kB
Tags Source
SHA-256 checksum
How to use checksums
cefabd51c7ff3cdc1c885e22d287592219fe1ca25623322806370a0ce9acd32b
BLAKE2b-256 checksum
How to use checksums
28cff6c148289fd87832e9f20428b7e842921efac5313cb3ac5920a424543760
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/3.8.0 pkginfo/1.8.2 readme-renderer/34.0 requests/2.25.1 requests-toolbelt/0.9.1 urllib3/1.26.12 tqdm/4.64.0 importlib-metadata/4.11.4 keyring/22.3.0 rfc3986/2.0.0 colorama/0.4.4 CPython/3.8.8

Release history Release notifications | RSS feed

This release

1.0.3 This release

1 release file

1.0.1

1 release file

1.0.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page