parakeet

HomePage: http://www.parakeetpython.com

Author: Alex Rubinsteyn

Download: https://pypi.python.org/packages/source/p/parakeet/parakeet-0.23.2.tar.gz

        Parakeet
========

Parakeet is a runtime accelerator for an array-oriented subset of
Python. If you're doing a lot of number crunching in Python, Parakeet
may be able to significantly speed up your code.

To accelerate a function, wrap it with Parakeet's **@jit** decorator:

::

    import numpy as np 
    from parakeet import jit 

    x = np.array([1,2,3])
    y = np.tanh(x * alpha) + beta

    @jit
    def fast(x, alpha = 0.5, beta = 0.3):
      return np.tanh(x * alpha) + beta 

    @jit 
    def loopy(x, alpha = 0.5, beta = 0.3):
      y = np.empty_like(x, dtype = float)
      for i in xrange(len(x)):
        y[i] = np.tanh(x[i] * alpha) + beta
      return y

    @jit
    def comprehension(x, alpha = 0.5, beta = 0.3):
      return np.array([np.tanh(xi*alpha) + beta for xi in x])

    assert np.allclose(fast(x), y)
    assert np.allclose(loopy(x), y)
    assert np.allclose(comprehension(x), y)

Install
=======

You should be able to install Parakeet from its `PyPI
package <https://pypi.python.org/pypi/parakeet/>`_ by running:

::

    pip install parakeet

Dependencies
============

Parakeet is written for Python 2.7 (sorry internet) and depends on:

-  `dsltools <https://github.com/iskandr/dsltools>`_
-  `nose <https://nose.readthedocs.org/en/latest/>`_ for unit tests
-  `NumPy <http://www.scipy.org/install.html>`_

The default backend (which uses OpenMP) requires ``gcc`` 4.4+.

*Windows*: If you have a 32-bit Windows install, your compiler should
come from `Cygwin <http://cygwin.com/install.html>`_ or
`MinGW <http://www.mingw.org/>`_. Getting Parakeet working on 64-bit
Windows is non-trivial and seems to require `colossal
hacks <http://eli.thegreenplace.net/2008/06/28/compiling-python-extensions-with-distutils-and-mingw/>`_.

*Mac OS X*: By default, your machine probably either has only
`clang <http://clang.llvm.org/>`_ or an outdated version of ``gcc``. You
can get a more recent version using
`HomeBrew <http://apple.stackexchange.com/questions/38222/how-do-i-install-gcc-via-homebrew>`_

If you want to use the CUDA backend, you need to have an NVIDIA graphics
card and install both the `CUDA
Toolkit <https://developer.nvidia.com/cuda-toolkit>`_ and
`PyCUDA <http://mathema.tician.de/software/pycuda/>`_.

How does it work?
=================

Your untyped function gets used as a template from which multiple *type
specializations* are generated (for each distinct set of input types).
These typed functions are then churned through many optimizations before
finally getting translated into native code.

More information
================

-  Read more about Parakeet on the `project
   website <http://www.parakeetpython.com>`_
-  Ask questions on the `discussion
   group <http://groups.google.com/forum/#!forum/parakeet-python>`_
-  Watch the `Parakeet presentation <https://vimeo.com/73895275>`_ from
   this year's `PyData Boston <http://pydata.org/bos2013>`_, look at the
   `HotPar
   slides <https://www.usenix.org/conference/hotpar12/parakeet-just-time-parallel-accelerator-python>`_
   from last year
-  Contact the `main developer <http://www.rubinsteyn.com>`_ directly

Supported language features
===========================

Parakeet cannot accelerate arbitrary Python code, it only supports a
limited subset of the language:

-  Scalar operations (i.e. ``x + 3 * y``)
-  Control flow (if-statements, loops, etc...)
-  Nested functions and lambdas
-  Tuples
-  Slices
-  NumPy array expressions (i.e. ``x[1:, :] + 2 * y[:-1, ::2]``)
-  Some NumPy library functions like ``np.ones`` and ``np.sin`` (look at
   the
   `mappings <https://github.com/iskandr/parakeet/blob/master/parakeet/mappings.py>`_
   module for a full list)
-  List literals (interpreted as array construction)
-  List comprehensions (interpreted as array comprehensions)
-  Parakeet's higher order array operations like ``parakeet.imap``,
   ``parakeet.scan``, and ``parakeet.allpairs``

Backends
========

Parakeet currently supports compilation to sequential C, multi-core C
with OpenMP (default), or LLVM (deprecated). To switch between these
options change ``parakee