Installation#

Note: to ensure that your installation is compatible with your local accelerators such as a GPU, we recommend to first follow the corresponding instructions to install JAX.

Alternative: Install from PyPI#

You can also install JAX Privacy from PyPI (version 1.0 or 2.0), but note that these releases will not have all the features available on GitHub head.

pip install jax-privacy

Local Development Installation#

This option is preferred if you want to build on top of our codebase or contribute to the library.

  1. Clone the repository:

    git clone https://github.com/google-parfait/jax_privacy
    
  2. Install the package in editable mode so modifications to the code are reflected in imports:

    cd jax_privacy
    pip install -e .