poulpyFully homomorphic encryption
GitHub Get started
Menu

Find a type or operation.

Choose a 0.8.3 crate reference, or build the API for the pinned source guide.

Source guide · 2394fa5

Scheme APIs

CrateUse it for
poulpy-ckksEncoding, encrypted numerical arithmetic, polynomial evaluation, and bootstrapping
poulpy-bin-fheBlind rotation, circuit bootstrapping, and encrypted integer arithmetic

Start with the CKKS or Binary FHE guide if you are looking for a runnable example.

Core and hardware abstraction

CrateUse it for
poulpy-coreCiphertexts, keys, encryption, and scheme-independent operations
poulpy-halBackend layouts, operation traits, and scratch memory

The codebase overview explains the dependency direction and extension points.

Backend APIs

These links cover published CPU backend APIs. Poulpy’s backend interface is hardware-independent, and a GPU backend is in active development. See Hardware targets for the broader scope.

For AVX2/FMA documentation from the pinned checkout:

RUSTFLAGS="-C target-feature=+avx2,+fma" cargo doc --locked --no-deps -p poulpy-cpu-avx --features enable-avx,enable-ckks --open

Match the reference to your checkout

The links above target the 0.8.3 APIs. Technical guides and examples use the pinned source baseline. Use the version selector for another published dependency version. For a source checkout, you can generate the reference for the exact code you are using:

cargo doc --locked --no-deps -p poulpy-hal -p poulpy-core -p poulpy-cpu-ref -p poulpy-ckks -p poulpy-bin-fhe --features poulpy-cpu-ref/enable-ckks --open