docs/pyutils.parallelize.rst

   1 pyutils.parallelize package
   2 ===========================
   3
   4 Submodules
   5 ----------
   6
   7 pyutils.parallelize.deferred\_operand module
   8 --------------------------------------------
   9
  10 DeferredOperand is the base class for SmartFuture.
  11
  12 .. automodule:: pyutils.parallelize.deferred_operand
  13    :members:
  14    :undoc-members:
  15    :show-inheritance:
  16
  17 pyutils.parallelize.executors module
  18 ------------------------------------
  19
  20 This module defines three executors: one for threads in the same
  21 process, one for separate processes on the same machine and the third
  22 for separate processes on remote machines.  Each can be used via the
  23 @parallelize decorator.  These executor pools are automatically
  24 cleaned up at program exit.
  25
  26
  27 .. automodule:: pyutils.parallelize.executors
  28    :members:
  29    :undoc-members:
  30    :show-inheritance:
  31
  32 pyutils.parallelize.parallelize module
  33 --------------------------------------
  34
  35 This module defines a decorator that can be used for simple parallelization.
  36
  37 .. automodule:: pyutils.parallelize.parallelize
  38    :members:
  39    :undoc-members:
  40    :show-inheritance:
  41
  42 pyutils.parallelize.smart\_future module
  43 ----------------------------------------
  44
  45 Defines a SmartFuture class that is part of the parallelization
  46 framework.  A SmartFuture is a kind of Future (i.e. a representation
  47 of the result of asynchronous processing that may know its value or
  48 not depending on whether the asynchronous operation has completed).
  49 Whereas normal Python Futures must be waited on or resolved manually,
  50 a SmartFuture automatically waits for its result to be known as soon
  51 as it is utilized in an expression that demands its value.
  52
  53 Also contains some utilility code for waiting for one/many futures.
  54
  55 .. automodule:: pyutils.parallelize.smart_future
  56    :members:
  57    :undoc-members:
  58    :show-inheritance:
  59
  60 pyutils.parallelize.thread\_utils module
  61 ----------------------------------------
  62
  63 Simple utils that deal with threads.
  64
  65 .. automodule:: pyutils.parallelize.thread_utils
  66    :members:
  67    :undoc-members:
  68    :show-inheritance:
  69
  70 Module contents
  71 ---------------
  72
  73 This module contains a framework for easy Python parallelization.  To
  74 see an example of how it is used, look at examples/wordle/...
  75
  76 This module also contains some utilities that deal with parallelization.
  77
  78 .. automodule:: pyutils.parallelize
  79    :members:
  80    :undoc-members:
  81    :show-inheritance: