API reference

The API reference follows the non-private Python module tree. It is generated from the current checkout without importing FHElium or compiling CUDA code. Signatures, docstrings, source links, module pages, and sidebar entries all come from the same abstract-syntax-tree scan. Some pages document implementation modules for contributors; supported import surfaces are the package initializers and modules that publish interfaces through __all__.

Choose by task

Task	Start with	Related guidance
Configure CKKS parameters	fhelium.config.ckks and fhelium.config.ntt	Choose a preset and depth
Assess an exact security-table row	fhelium.config.security	Security scope
Create and use an evaluator	fhelium.engine.ckks_engine	Quickstart
Control scale and level with separate operations	fhelium.engine.ckks_engine	Scale and level lifecycle
Inspect typed values and keys	fhelium.core.ciphertext, fhelium.core.plaintext, and fhelium.core.keys	Value model and identity
Persist an exact value	fhelium.serialization.value	Serialization and artifacts
Capture or reuse repeated work	fhelium.execution.cuda_graph and fhelium.execution.buffer	Execution concepts
Manage local value placement, admission, lifetimes, plans, and deterministic automation	fhelium.residency.manager, model, plan, request, and controller	Residency lifetimes
Trace, import, transform, and execute a mixed-dialect program	fhelium.experimental.jit and fhelium.experimental.jit.passes	JIT programs
Coordinate processes and collectives	fhelium.distributed	SPMD model
Inspect native-extension availability and ABI diagnostics	fhelium.native	Inspect runtime and CUDA topology
Inspect CUDA devices and peer topology programmatically	fhelium.native.cuda	Inspect runtime and CUDA topology
Use experimental CKKS facilities	fhelium.experimental.bootstrap, fhelium.experimental.jit, and fhelium.experimental.mpc	Bootstrapping semantics and range requirements and multiparty supported security scope

Generation rule

scripts/generate_api_docs.py discovers Python source modules whose paths have no leading-underscore component. Package initializers with a defined __all__ are included because they define supported import surfaces; other package initializers are omitted.

For each discovered module, a defined __all__ defines the members when it is present. Otherwise, the generator includes non-underscored classes, functions, and data definitions. Module-path components and page titles are kept exactly as they occur in Python. Modules with a leading-underscore path component are implementation details and are omitted.

Sidebar grouping is mechanical: modules are grouped by their first package segment, while every item retains its complete Python module name. Adding, removing, or renaming a source module changes the generated pages and sidebar on the next build. The API index is reached from the top navigation and is not repeated as an “Overview” sidebar item.

The sole configured module-tree exclusion is fhelium.native.wrapper, which contains generated Torch-operator bindings.