Commit 28b6076c authored by Pierre Augier's avatar Pierre Augier
Browse files

Update the documentation on how to choose the backend

parent 8de0943befee
......@@ -4,9 +4,28 @@ Backends (Pythran, Cython, Numba, ...)
Transonic can use different tools to accelerate the code. We use the name
The default backend is Pythran and currently, one can choose other backends
with the environment variable :code:`TRANSONIC_BACKEND` (which has to be
"pythran", "cython", "numba" or "python").
The default backend is Pythran and currently, there are 3 other backends
("cython", "numba" or "python"). (The "python" backend is mainly used for
internal testing.)
There are different methods to choose which backend is used:
- An environment variable :code:`TRANSONIC_BACKEND` (which has to be "pythran",
"cython", "numba" or "python") should be used to change the backend globally
for one process.
- The ``transonic`` commandline has an option ``-b`` (``--backend``).
- The functions :func:`transonic.backends.make_backend_files` and
:func:`transonic.dist.init_transonic_extensions` have an optional argument
``backend``. Note that these functions should be imported from the
:mod:`transonic.dist` package.
- There are two functions :func:`transonic.config.set_backend` and
:func:`transonic.backends.set_backend_for_this_module`. Note that these
functions can be imported from the :mod:`transonic` package.
- The ``boost`` and ``jit`` decorators have an optional argument ``backend``.
.. toctree::
:maxdepth: 2
......@@ -21,9 +21,6 @@ User API
.. autofunction:: set_backend_for_this_module
Internal API
.. autofunction:: make_backend_files
......@@ -33,6 +33,11 @@ For Linux, I use:
User API
.. autofunction:: set_backend
import os
......@@ -49,6 +54,7 @@ backend_set_by_user = False
def set_backend(backend: str):
"""Set the "global variable" backend_default"""
backend = backend.lower()
supported_backends = ["pythran", "cython", "numba", "python"]
......@@ -9,6 +9,8 @@
.. autofunction:: detect_transonic_extensions
.. autofunction:: init_transonic_extensions
import os
......@@ -53,6 +55,7 @@ __all__ = [
......@@ -141,6 +144,11 @@ def init_transonic_extensions(
Package to be recursively scanned for Pythran extensions.
backend : str
Only initialize extensions for this backend. If None, initialize
extensions for the default backend (set by an environment variable).
Directories to include while building extensions, for e.g.:
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment