Zero-copy MPI communication of JAX arrays, for turbo-charged HPC applications in Python ⚡
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
Project description
mpi4jax enables zero-copy, multi-host communication of JAX arrays, even from jitted code and from GPU memory.
But why?
The JAX framework has great performance for scientific computing workloads, but its multi-host capabilities are still limited.
With mpi4jax, you can scale your JAX-based simulations to entire CPU and GPU clusters (without ever leaving jax.jit).
In the spirit of differentiable programming, mpi4jax also supports differentiating through some MPI operations.
Installation
mpi4jax is available through pip and conda:
$ pip install mpi4jax # Pip
$ conda install -c conda-forge mpi4jax # condaDepending on the different jax backends you want to use, you can install mpi4jax in the following way
# pip install 'jax[cpu]'
$ pip install mpi4jax
# pip install -U 'jax[cuda12]'
$ pip install cython
$ pip install mpi4jax --no-build-isolation
# pip install -U 'jax[cuda12_local]'
$ CUDA_ROOT=XXX pip install mpi4jax(for more informations on jax GPU distributions, see the JAX installation instructions)
In case your MPI installation is not detected correctly, it can help to install mpi4py separately. When using a pre-installed mpi4py, you must use --no-build-isolation when installing mpi4jax:
# if mpi4py is already installed
$ pip install cython
$ pip install mpi4jax --no-build-isolationOur documentation includes some more advanced installation examples.
Example usage
from mpi4py import MPI
import jax
import jax.numpy as jnp
import mpi4jax
comm = MPI.COMM_WORLD
rank = comm.Get_rank()
@jax.jit
def foo(arr):
arr = arr + rank
arr_sum, _ = mpi4jax.allreduce(arr, op=MPI.SUM, comm=comm)
return arr_sum
a = jnp.zeros((3, 3))
result = foo(a)
if rank == 0:
print(result)Running this script on 4 processes gives:
$ mpirun -n 4 python example.py
[[6. 6. 6.]
[6. 6. 6.]
[6. 6. 6.]]allreduce is just one example of the MPI primitives you can use. See all supported operations here.
Community guidelines
If you have a question or feature request, or want to report a bug, feel free to open an issue.
We welcome contributions of any kind through pull requests. For information on running our tests, debugging, and contribution guidelines please refer to the corresponding documentation page.
How to cite
If you use mpi4jax in your work, please consider citing the following article:
@article{mpi4jax,
doi = {10.21105/joss.03419},
url = {https://doi.org/10.21105/joss.03419},
year = {2021},
publisher = {The Open Journal},
volume = {6},
number = {65},
pages = {3419},
author = {Dion Häfner and Filippo Vicentini},
title = {mpi4jax: Zero-copy MPI communication of JAX arrays},
journal = {Journal of Open Source Software}
}
Project details
Verified details
These details have been verified by PyPIProject links
GitHub Statistics
Maintainers
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file mpi4jax-0.7.1.tar.gz.
File metadata
- Download URL: mpi4jax-0.7.1.tar.gz
- Upload date:
- Size: 70.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.12.9
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9c07a1739cd3362819c77f160c9bfe060bc1b1e2275a9cb996a4ec39e3d98e6f |
|
| MD5 | cb87eb357d8da9a31bd9ef7902006067 |
|
| BLAKE2b-256 | 70308e0471fc89456ebf90ea5c50307b04accbfd50dcaf4352fbd64b798e196d |
Provenance
The following attestation bundles were made for mpi4jax-0.7.1.tar.gz:
Publisher:
python-publish.yml on mpi4jax/mpi4jax
-
Statement:
- Statement type:
https://in-toto.io/Statement/v1 - Predicate type:
https://docs.pypi.org/attestations/publish/v1 - Subject name:
mpi4jax-0.7.1.tar.gz - Subject digest:
9c07a1739cd3362819c77f160c9bfe060bc1b1e2275a9cb996a4ec39e3d98e6f - Sigstore transparency entry: 184053737
- Sigstore integration time:
- Permalink:
mpi4jax/mpi4jax@b139c5b9fb95839399ce2c4ae3a80fe3133d3b76 - Branch / Tag:
refs/tags/v0.7.1 - Owner: https://github.com/mpi4jax
- Access:
public
- Token Issuer:
https://token.actions.githubusercontent.com - Runner Environment:
github-hosted - Publication workflow:
python-publish.yml@b139c5b9fb95839399ce2c4ae3a80fe3133d3b76 - Trigger Event:
release
- Statement type:
