Skip to content

API reference overview

These pages are generated directly from the package docstrings, so they always match the version of the code they were built from. Use the version selector in the header to switch between releases.

Layers

Layer Modules What lives there
Core arithmetic, arrays compare/sign, bounded division, sorting networks, reductions, array utilities
Math basic, combinatorics, number_theory, fixed_point, special, bits, binary_division Python-math-style bounded helpers, LUT guardrails, bit-level circuits
Machine learning core, models, matrix, activations, stats, utils encrypted metrics, model inference, matrix algebra, activations
Finance core, transactions rate/tax/interest helpers under the RATE_SCALE money convention

Calling conventions

Most operations come in three forms:

  • operation(...) — friendly BoundedOperation objects in concrete_fhe_toolkit.math compile a circuit directly.
  • compile_*(...) — explicit compiler returning an fhe.Circuit.
  • make_*(...) — returns a traceable function for composing your own larger Concrete program.

All inputs are bounded integers: choose public bounds at compile time and keep runtime inputs inside them. See the API usage guide and Bounds and costs for the full model.