API
Last updated
Was this helpful?
Last updated
Was this helpful?
: Compiler submodule.
: CompilationContext.
: Compilation feedback.
: Import and export TFHErs integers into Concrete.
: Common utils for the compiler submodule.
: Concrete.
: Glue the compilation process together.
: Declaration of DebugArtifacts class.
: Declaration of Circuit class.
: Declaration of Client class.
: Declaration of Compiler class.
: Declaration of classes related to composition.
: Declaration of Configuration class.
: Declaration of circuit and compiler decorators.
: Declaration of EvaluationKeys.
: Declaration of Keys class.
: Declaration of FheModule classes.
: Declaration of MultiCompiler class.
: Declaration of Server class.
: Declaration of ClientSpecs class.
: Declaration of EncryptionStatus class.
: Declaration of various functions and constants related to compilation.
: Declaration of Value class.
: Declaration of wiring related class.
: Define available data types and their semantics.
: Declaration of BaseDataType abstract class.
: Declaration of Float class.
: Declaration of Integer class.
: Declaration of various functions and constants related to data types.
: Provide additional features that are not present in numpy.
: Declaration of array function, to simplify creation of encrypted arrays.
: Bit extraction extensions.
: Declaration of constant functions, to allow server side trivial encryption.
: Tracing and evaluation of convolution.
: Declaration of hinting extensions, to provide more information to Concrete.
: Declaration of identity extension.
: Tracing and evaluation of maxpool.
: Declaration of multivariate extension.
: Declaration of ones and one functions, to simplify creation of encrypted ones.
: Declaration of relu extension.
: Declaration of round_bit_pattern function, to provide an interface for rounded table lookups.
: Declaration of LookupTable class.
: Declaration of tag context manager, to allow tagging certain nodes.
: Declaration of truncate_bit_pattern extension.
: Declaration of univariate function.
: Declaration of zeros and zero functions, to simplify creation of encrypted zeros.
.
: Declaration of various functions and constants related to the entire project.
: Provide computation graph to mlir functionality.
: Declaration of Context class.
: Declaration of ConversionType and Conversion classes.
: Declaration of Converter class.
: All graph processors.
: Declaration of AssignBitWidths graph processor.
: Declaration of AssignNodeIds graph processor.
: Declaration of CheckIntegerOnly graph processor.
: Declaration of ProcessRounding graph processor.
: Declaration of various functions and constants related to MLIR conversion.
: Define structures used to represent computation.
: Declaration of various Evaluator classes, to make graphs picklable.
: Declaration of Graph class.
: Declaration of Node class.
: Declaration of Operation enum.
: Declaration of various functions and constants related to representation of computation.
: tfhers module to represent, and compute on tfhers integer values.
: Declaration of tfhers.Bridge class.
: Declaration of TFHERSIntegerType class.
: TFHE-rs client specs.
: Tracing of tfhers operations.
: Declaration of TFHERSInteger which wraps values as being of tfhers types.
: Provide function to computation graph functionality.
: Declaration of Tracer class.
: Declaration of type annotation.
: Define the available values and their semantics.
: Declaration of ClearScalar and EncryptedScalar wrappers.
: Declaration of ClearTensor and EncryptedTensor wrappers.
: Declaration of ValueDescription class.
: Version of the project, which is updated automatically by the CI right before releasing.
: Concretelang python module
: FHE dialect module
: FHELinalg dialect module
: Tracing dialect module
: Compilation context.
: Helper class for compilation feedback.
: A helper class to import and export TFHErs big integers.
: DebugArtifacts class, to export information about the compilation process for single function.
: A debug manager, allowing streamlined debugging.
: An object containing debug artifacts for a certain function in an fhe module.
: An object containing debug artifacts for an fhe module.
: Circuit class, to combine computation graph, mlir, client and server into a single object.
: Client class, which can be used to manage keys, encrypt arguments and decrypt results.
: Compiler class, to glue the compilation pipeline.
: A raw composition clause.
: A protocol for composition policies.
: A raw composition rule.
: Controls the behavior of approximate rounding.
: BitwiseStrategy, to specify implementation preference for bitwise operations.
: ComparisonStrategy, to specify implementation preference for comparisons.
: Configuration class, to allow the compilation process to be customized.
.
: MinMaxStrategy, to specify implementation preference for minimum and maximum operations.
: MultiParamStrategy, to set optimization strategy for multi-parameter.
: MultivariateStrategy, to specify implementation preference for multivariate operations.
: ParameterSelectionStrategy, to set optimization strategy.
: Security level used to optimize the circuit parameters.
: Compilable class, to wrap a function and provide methods to trace and compile it.
: EvaluationKeys required for execution.
: Keys class, to manage generate/reuse keys.
: Runtime object class for execution.
: Fhe function class, allowing to run or simulate one function of an fhe module.
: Fhe module class, to combine computation graphs, mlir, runtime objects into a single object.
: Runtime object class for simulation.
: An object representing the definition of a function as used in an fhe module.
: Compiler class for multiple functions, to glue the compilation pipeline.
: Server class, which can be used to perform homomorphic computation.
: ClientSpecs class, to create Client objects.
: EncryptionStatus enum, to represent encryption status of parameters.
: A lazyly initialized value.
: A public value object that can be sent between client and server.
: Composition policy that allows to forward any output of the module to any of its input.
: All the encrypted inputs of a given function of a module.
: All the encrypted outputs of a given function of a module.
: The input of a given function of a module.
: Composition policy that does not allow the forwarding of any output to any input.
: The output of a given function of a module.
: A wrapper type used to trace wiring.
: A forwarding rule between an output and an input.
: A protocol for wire inputs.
: A protocol for wire outputs.
: A context manager returned by the wire_pipeline method.
: Composition policy which allows the forwarding of certain outputs to certain inputs.
: BaseDataType abstract class, to form a basis for data types.
: Float class, to represent floating point numbers.
: Integer class, to represent integers.
: Bits class, to provide indexing into the bits of integers.
: Adjusting class, to be used as early stop signal during adjustment.
: AutoRounder class, to optimize for number of msbs to keep during round bit pattern operation.
: LookupTable class, to provide a way to do direct table lookups.
: Adjusting class, to be used as early stop signal during adjustment.
: AutoTruncator class, to optimize for the number of msbs to keep during truncate operation.
: Context class, to perform operations on conversions.
: Conversion class, to store MLIR operations with additional information.
: ConversionType class, to make it easier to work with MLIR types.
: Converter class, to convert a computation graph to MLIR.
: AdditionalConstraints class to customize bit-width assignment step easily.
: AssignBitWidths graph processor, to assign proper bit-widths to be compatible with FHE.
to node properties.
: CheckIntegerOnly graph processor, to make sure the graph only contains integer nodes.
: ProcessRounding graph processor, to analyze rounding and support regular operations on it.
: Comparison enum, to store the result comparison in 2-bits as there are three possible outcomes.
: HashableNdarray class, to use numpy arrays in dictionaries.
: ConstantEvaluator class, to evaluate Operation.Constant nodes.
: GenericEvaluator class, to evaluate Operation.Generic nodes.
: GenericEvaluator class, to evaluate Operation.Generic nodes where args are packed in a tuple.
: InputEvaluator class, to evaluate Operation.Input nodes.
: Graph class, to represent computation graphs.
: GraphProcessor base class, to define the API for a graph processing pipeline.
: MultiGraphProcessor base class, to define the API for a multiple graph processing pipeline.
: Node class, to represent computation in a computation graph.
: Operation enum, to distinguish nodes within a computation graph.
: TFHErs Bridge extend a Client with TFHErs functionalities.
: Crypto parameters used for a tfhers integer.
: TFHErs key choice: big or small.
to represent tfhers integer types.
: TFHE-rs client specs.
into typed values, using tfhers types.
: Base annotation for direct definition.
: Base scalar annotation for direct definition.
: Base tensor annotation for direct definition.
: Tracer class, to create computation graphs from python functions.
: Scalar f32 annotation.
: Scalar f64 annotation.
: Scalar int1 annotation.
: Scalar int10 annotation.
: Scalar int11 annotation.
: Scalar int12 annotation.
: Scalar int13 annotation.
: Scalar int14 annotation.
: Scalar int15 annotation.
: Scalar int16 annotation.
: Scalar int17 annotation.
: Scalar int18 annotation.
: Scalar int19 annotation.
: Scalar int2 annotation.
: Scalar int20 annotation.
: Scalar int21 annotation.
: Scalar int22 annotation.
: Scalar int23 annotation.
: Scalar int24 annotation.
: Scalar int25 annotation.
: Scalar int26 annotation.
: Scalar int27 annotation.
: Scalar int28 annotation.
: Scalar int29 annotation.
: Scalar int3 annotation.
: Scalar int30 annotation.
: Scalar int31 annotation.
: Scalar int32 annotation.
: Scalar int33 annotation.
: Scalar int34 annotation.
: Scalar int35 annotation.
: Scalar int36 annotation.
: Scalar int37 annotation.
: Scalar int38 annotation.
: Scalar int39 annotation.
: Scalar int4 annotation.
: Scalar int40 annotation.
: Scalar int41 annotation.
: Scalar int42 annotation.
: Scalar int43 annotation.
: Scalar int44 annotation.
: Scalar int45 annotation.
: Scalar int46 annotation.
: Scalar int47 annotation.
: Scalar int48 annotation.
: Scalar int49 annotation.
: Scalar int5 annotation.
: Scalar int50 annotation.
: Scalar int51 annotation.
: Scalar int52 annotation.
: Scalar int53 annotation.
: Scalar int54 annotation.
: Scalar int55 annotation.
: Scalar int56 annotation.
: Scalar int57 annotation.
: Scalar int58 annotation.
: Scalar int59 annotation.
: Scalar int6 annotation.
: Scalar int60 annotation.
: Scalar int61 annotation.
: Scalar int62 annotation.
: Scalar int63 annotation.
: Scalar int64 annotation.
: Scalar int7 annotation.
: Scalar int8 annotation.
: Scalar int9 annotation.
: Tensor annotation.
: Scalar uint1 annotation.
: Scalar uint10 annotation.
: Scalar uint11 annotation.
: Scalar uint12 annotation.
: Scalar uint13 annotation.
: Scalar uint14 annotation.
: Scalar uint15 annotation.
: Scalar uint16 annotation.
: Scalar uint17 annotation.
: Scalar uint18 annotation.
: Scalar uint19 annotation.
: Scalar uint2 annotation.
: Scalar uint20 annotation.
: Scalar uint21 annotation.
: Scalar uint22 annotation.
: Scalar uint23 annotation.
: Scalar uint24 annotation.
: Scalar uint25 annotation.
: Scalar uint26 annotation.
: Scalar uint27 annotation.
: Scalar uint28 annotation.
: Scalar uint29 annotation.
: Scalar uint3 annotation.
: Scalar uint30 annotation.
: Scalar uint31 annotation.
: Scalar uint32 annotation.
: Scalar uint33 annotation.
: Scalar uint34 annotation.
: Scalar uint35 annotation.
: Scalar uint36 annotation.
: Scalar uint37 annotation.
: Scalar uint38 annotation.
: Scalar uint39 annotation.
: Scalar uint4 annotation.
: Scalar uint40 annotation.
: Scalar uint41 annotation.
: Scalar uint42 annotation.
: Scalar uint43 annotation.
: Scalar uint44 annotation.
: Scalar uint45 annotation.
: Scalar uint46 annotation.
: Scalar uint47 annotation.
: Scalar uint48 annotation.
: Scalar uint49 annotation.
: Scalar uint5 annotation.
: Scalar uint50 annotation.
: Scalar uint51 annotation.
: Scalar uint52 annotation.
: Scalar uint53 annotation.
: Scalar uint54 annotation.
: Scalar uint55 annotation.
: Scalar uint56 annotation.
: Scalar uint57 annotation.
: Scalar uint58 annotation.
: Scalar uint59 annotation.
: Scalar uint6 annotation.
: Scalar uint60 annotation.
: Scalar uint61 annotation.
: Scalar uint62 annotation.
: Scalar uint63 annotation.
: Scalar uint64 annotation.
: Scalar uint7 annotation.
: Scalar uint8 annotation.
: Scalar uint9 annotation.
: ValueDescription class, to combine data type, shape, and encryption status into a single object.
: Check whether a CUDA device is available and online.
: Check whether the compiler and runtime support GPU offloading.
: Initialize dataflow parallelization.
: Parse the MLIR input, then return it back.
: Extract tag of the operation from its location.
: Try to find the absolute path to the runtime library.
: Provide a direct interface for compilation of single circuit programs.
: Provide an easy interface for the compilation of single-circuit programs.
: Provide an easy interface to define a function within an fhe module.
: Provide an easy interface for the compilation of multi functions modules.
: Add nodes from from_nodes to to_nodes, to all_nodes.
: Determine if a subgraph can be fused.
: Convert a subgraph to Operation.Generic node.
: Find the closest upstream integer output nodes to a set of start nodes in a graph.
: Find a subgraph with float computations that end with an integer output.
: Find the single lowest common ancestor of a list of nodes.
: Find a subgraph with a tlu computation that has multiple variable inputs where all variable inputs share a common ancestor.
: Convert a type to a string. Remove package name and class/type keywords.
: Fuse appropriate subgraphs in a graph to a single Operation.Generic node.
: Get the terminal size.
: Generate a random inputset.
: Determine if a node is the single common ancestor of a list of nodes.
: Validate input arguments.
: Get the 'BaseDataType' that can represent a set of 'BaseDataType's.
: Create an encrypted array from either encrypted or clear values.
: Extract bits of integers.
: Trivial encryption of a cleartext value.
: Trace and evaluate convolution operations.
: Hint the compilation process about properties of a value.
: Apply identity function to x.
: Refresh x.
: Evaluate or trace MaxPool operation.
: Wrap a multivariate function so that it is traced into a single generic node.
: Create an encrypted scalar with the value of one.
: Create an encrypted array of ones.
: Create an encrypted array of ones with the same shape as another array.
: Rectified linear unit extension.
: Round the bit pattern of an integer.
: Introduce a new tag to the tag stack.
: Round the bit pattern of an integer.
: Wrap a univariate function so that it is traced into a single generic node.
: Create an encrypted scalar with the value of zero.
: Create an encrypted array of zeros.
: Create an encrypted array of zeros with the same shape as another array.
: Assert a condition.
: Raise a RuntimeError to indicate unreachable code is entered.
: Construct lookup tables for each cell of the input for an Operation.Generic node.
: Construct the lookup table for an Operation.Generic node.
: Construct the lookup table for a multivariate node.
: Use flooding algorithm to replace None values.
: Get the textual representation of a constant.
: Format an indexing element.
: Get a TFHE-rs integer type from TFHE-rs parameters in JSON format.
: Get a TFHE-rs integer type from TFHE-rs parameters in JSON format.
: Create a TFHErs bridge from a circuit or module or client.
: Convert a Concrete integer to the tfhers representation.
: Convert a tfhers integer to the Concrete representation.
: Build a clear scalar value.
: Build an encrypted scalar value.
: Build a clear scalar value.
: Build an encrypted scalar value.
: Build a clear tensor value.
: Build an encrypted tensor value.
: Build a clear tensor value.
: Build an encrypted tensor value.