From d16ce818e13cdf8eb9693fabb4ddc82ce4fb9523 Mon Sep 17 00:00:00 2001 From: youben11 Date: Fri, 8 Sep 2023 06:27:57 +0100 Subject: [PATCH] docs(compiler): build latest docs --- docs/dev/compilation/FHEDialect.md | 64 ++++++++++++------------ docs/dev/compilation/FHELinalgDialect.md | 54 +++++++++----------- 2 files changed, 57 insertions(+), 61 deletions(-) diff --git a/docs/dev/compilation/FHEDialect.md b/docs/dev/compilation/FHEDialect.md index a2d7a8b90..c6e1389c9 100644 --- a/docs/dev/compilation/FHEDialect.md +++ b/docs/dev/compilation/FHEDialect.md @@ -29,7 +29,7 @@ Example: Traits: AlwaysSpeculatableImplTrait -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: Binary, BinaryEintInt, ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) Effects: MemoryEffects::Effect{} @@ -67,7 +67,7 @@ Example: Traits: AlwaysSpeculatableImplTrait -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: BinaryEint, ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) Effects: MemoryEffects::Effect{} @@ -104,7 +104,7 @@ Example: Traits: AlwaysSpeculatableImplTrait -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: ConditionallySpeculatable, ConstantNoise, NoMemoryEffect (MemoryEffectOpInterface) Effects: MemoryEffects::Effect{} @@ -188,7 +188,7 @@ Example: Traits: AlwaysSpeculatableImplTrait -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface), UnaryEint Effects: MemoryEffects::Effect{} @@ -273,7 +273,7 @@ Examples: Traits: AlwaysSpeculatableImplTrait -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface), UnaryEint Effects: MemoryEffects::Effect{} @@ -287,7 +287,7 @@ Effects: MemoryEffects::Effect{} | Result | Description | | :----: | ----------- | -«unnamed» | An encrypted integer +«unnamed» | An encrypted unsigned integer ### `FHE.gen_gate` (::mlir::concretelang::FHE::GenGateOp) @@ -348,7 +348,7 @@ Example: Traits: AlwaysSpeculatableImplTrait -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: BinaryEint, ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) Effects: MemoryEffects::Effect{} @@ -386,7 +386,7 @@ Example: Traits: AlwaysSpeculatableImplTrait -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: Binary, BinaryEintInt, ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) Effects: MemoryEffects::Effect{} @@ -428,7 +428,7 @@ Example: Traits: AlwaysSpeculatableImplTrait -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: BinaryEint, ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) Effects: MemoryEffects::Effect{} @@ -493,7 +493,7 @@ Example: Traits: AlwaysSpeculatableImplTrait -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface), UnaryEint Effects: MemoryEffects::Effect{} @@ -533,7 +533,7 @@ Rounds a ciphertext to a smaller precision. Traits: AlwaysSpeculatableImplTrait -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface), UnaryEint Effects: MemoryEffects::Effect{} @@ -570,7 +570,7 @@ Example: Traits: AlwaysSpeculatableImplTrait -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: Binary, BinaryEintInt, ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) Effects: MemoryEffects::Effect{} @@ -608,7 +608,7 @@ Example: Traits: AlwaysSpeculatableImplTrait -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: BinaryEint, ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) Effects: MemoryEffects::Effect{} @@ -646,7 +646,7 @@ Example: Traits: AlwaysSpeculatableImplTrait -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: Binary, BinaryIntEint, ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) Effects: MemoryEffects::Effect{} @@ -682,7 +682,7 @@ Examples: Traits: AlwaysSpeculatableImplTrait -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface), UnaryEint Effects: MemoryEffects::Effect{} @@ -690,7 +690,7 @@ Effects: MemoryEffects::Effect{} | Operand | Description | | :-----: | ----------- | -| `input` | An encrypted integer +| `input` | An encrypted unsigned integer #### Results: @@ -717,7 +717,7 @@ Examples: Traits: AlwaysSpeculatableImplTrait -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface), UnaryEint Effects: MemoryEffects::Effect{} @@ -725,7 +725,7 @@ Effects: MemoryEffects::Effect{} | Operand | Description | | :-----: | ----------- | -| `input` | An encrypted integer +| `input` | An encrypted unsigned integer #### Results: @@ -752,7 +752,7 @@ Examples: Traits: AlwaysSpeculatableImplTrait -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface), UnaryEint Effects: MemoryEffects::Effect{} @@ -766,7 +766,7 @@ Effects: MemoryEffects::Effect{} | Result | Description | | :----: | ----------- | -«unnamed» | An encrypted integer +«unnamed» | An encrypted unsigned integer ### `FHE.zero` (::mlir::concretelang::FHE::ZeroEintOp) @@ -780,7 +780,7 @@ Example: Traits: AlwaysSpeculatableImplTrait -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: ConditionallySpeculatable, ConstantNoise, NoMemoryEffect (MemoryEffectOpInterface) Effects: MemoryEffects::Effect{} @@ -804,7 +804,7 @@ Example: Traits: AlwaysSpeculatableImplTrait -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: ConditionallySpeculatable, ConstantNoise, NoMemoryEffect (MemoryEffectOpInterface) Effects: MemoryEffects::Effect{} @@ -824,16 +824,16 @@ Syntax: `!FHE.ebool` An encrypted boolean. -### EncryptedIntegerType +### EncryptedSignedIntegerType -An encrypted integer +An encrypted signed integer -An encrypted integer with `width` bits to performs FHE Operations. +An encrypted signed integer with `width` bits to performs FHE Operations. Examples: ```mlir -!FHE.eint<7> -!FHE.eint<6> +!FHE.esint<7> +!FHE.esint<6> ``` #### Parameters: @@ -842,16 +842,16 @@ Examples: | :-------: | :-------: | ----------- | | width | `unsigned` | | -### EncryptedSignedIntegerType +### EncryptedUnsignedIntegerType -An encrypted signed integer +An encrypted unsigned integer -An encrypted signed integer with `width` bits to performs FHE Operations. +An encrypted unsigned integer with `width` bits to performs FHE Operations. Examples: ```mlir -!FHE.esint<7> -!FHE.esint<6> +!FHE.eint<7> +!FHE.eint<6> ``` #### Parameters: diff --git a/docs/dev/compilation/FHELinalgDialect.md b/docs/dev/compilation/FHELinalgDialect.md index 000de0d29..eed023f33 100644 --- a/docs/dev/compilation/FHELinalgDialect.md +++ b/docs/dev/compilation/FHELinalgDialect.md @@ -48,7 +48,7 @@ Examples: Traits: AlwaysSpeculatableImplTrait, TensorBinaryEintInt, TensorBroadcastingRules -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: Binary, BinaryEintInt, ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) Effects: MemoryEffects::Effect{} @@ -104,7 +104,7 @@ Examples: Traits: AlwaysSpeculatableImplTrait, TensorBinaryEint, TensorBroadcastingRules -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: BinaryEint, ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) Effects: MemoryEffects::Effect{} @@ -123,7 +123,7 @@ Effects: MemoryEffects::Effect{} ### `FHELinalg.apply_lookup_table` (::mlir::concretelang::FHELinalg::ApplyLookupTableEintOp) -Returns a tensor that contains the result of a lookup table. +Returns a tensor that contains the result of the lookup on a table. For each encrypted index, performs a lookup table of clear integers. @@ -148,7 +148,7 @@ Examples: Traits: AlwaysSpeculatableImplTrait -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: ConditionallySpeculatable, ConstantNoise, NoMemoryEffect (MemoryEffectOpInterface) Effects: MemoryEffects::Effect{} @@ -167,7 +167,7 @@ Effects: MemoryEffects::Effect{} ### `FHELinalg.apply_mapped_lookup_table` (::mlir::concretelang::FHELinalg::ApplyMappedLookupTableEintOp) -Returns a tensor that contains the result of a lookup table, using a different lookup table for each element, specified by a map. +Returns a tensor that contains the result of the lookup on a table, using a different lookup table for each element, specified by a map. Performs for each encrypted index a lookup table of clear integers. Multiple lookup tables are passed, and the application of lookup tables is performed following the broadcasting rules. The precise lookup is specified by a map. @@ -209,7 +209,7 @@ Others examples: Traits: AlwaysSpeculatableImplTrait -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: ConditionallySpeculatable, ConstantNoise, NoMemoryEffect (MemoryEffectOpInterface) Effects: MemoryEffects::Effect{} @@ -229,7 +229,7 @@ Effects: MemoryEffects::Effect{} ### `FHELinalg.apply_multi_lookup_table` (::mlir::concretelang::FHELinalg::ApplyMultiLookupTableEintOp) -Returns a tensor that contains the result of a lookup table, using a different lookup table for each element. +Returns a tensor that contains the result of the lookup on a table, using a different lookup table for each element. Performs for each encrypted index a lookup table of clear integers. Multiple lookup tables are passed, and the application of lookup tables is performed following the broadcasting rules. @@ -265,7 +265,7 @@ Examples: Traits: AlwaysSpeculatableImplTrait -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: ConditionallySpeculatable, ConstantNoise, NoMemoryEffect (MemoryEffectOpInterface) Effects: MemoryEffects::Effect{} @@ -337,12 +337,12 @@ Effects: MemoryEffects::Effect{} ### `FHELinalg.conv2d` (::mlir::concretelang::FHELinalg::Conv2dOp) -Returns the 2D convolution of a tensor in NCHW form with weights in the form FCHW +Returns the 2D convolution of a tensor in the form NCHW with weights in the form FCHW Traits: AlwaysSpeculatableImplTrait -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: Binary, BinaryEintInt, ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) Effects: MemoryEffects::Effect{} @@ -384,7 +384,7 @@ Examples: Traits: AlwaysSpeculatableImplTrait -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: Binary, BinaryEintInt, ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) Effects: MemoryEffects::Effect{} @@ -735,7 +735,7 @@ Examples: Traits: AlwaysSpeculatableImplTrait, TensorBinaryEintInt -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: Binary, BinaryEintInt, ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) Effects: MemoryEffects::Effect{} @@ -881,7 +881,7 @@ Examples: Traits: AlwaysSpeculatableImplTrait, TensorBinaryIntEint -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: Binary, BinaryIntEint, ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) Effects: MemoryEffects::Effect{} @@ -900,14 +900,10 @@ Effects: MemoryEffects::Effect{} ### `FHELinalg.maxpool2d` (::mlir::concretelang::FHELinalg::Maxpool2dOp) -Returns the 2D maxpool of a tensor in NCHW form - - -Traits: AlwaysSpeculatableImplTrait +Returns the 2D maxpool of a tensor in the form NCHW -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) -Effects: MemoryEffects::Effect{} +Interfaces: UnaryEint #### Attributes: @@ -969,7 +965,7 @@ Examples: Traits: AlwaysSpeculatableImplTrait, TensorBinaryEintInt, TensorBroadcastingRules -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: Binary, BinaryEintInt, ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) Effects: MemoryEffects::Effect{} @@ -1025,7 +1021,7 @@ Examples: Traits: AlwaysSpeculatableImplTrait, TensorBinaryEint, TensorBroadcastingRules -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: BinaryEint, ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) Effects: MemoryEffects::Effect{} @@ -1062,7 +1058,7 @@ Examples: Traits: AlwaysSpeculatableImplTrait, TensorUnaryEint -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface), UnaryEint Effects: MemoryEffects::Effect{} @@ -1101,7 +1097,7 @@ Rounds a tensor of ciphertexts into a smaller precision. Traits: AlwaysSpeculatableImplTrait, TensorUnaryEint -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface), UnaryEint Effects: MemoryEffects::Effect{} @@ -1157,7 +1153,7 @@ Examples: Traits: AlwaysSpeculatableImplTrait, TensorBinaryEintInt, TensorBroadcastingRules -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: Binary, BinaryEintInt, ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) Effects: MemoryEffects::Effect{} @@ -1213,7 +1209,7 @@ Examples: Traits: AlwaysSpeculatableImplTrait, TensorBinaryEint, TensorBroadcastingRules -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: BinaryEint, ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) Effects: MemoryEffects::Effect{} @@ -1270,7 +1266,7 @@ Examples: Traits: AlwaysSpeculatableImplTrait, TensorBinaryIntEint, TensorBroadcastingRules -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: Binary, BinaryIntEint, ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) Effects: MemoryEffects::Effect{} @@ -1398,7 +1394,7 @@ Examples: Traits: AlwaysSpeculatableImplTrait -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface), UnaryEint Effects: MemoryEffects::Effect{} @@ -1434,7 +1430,7 @@ Examples: Traits: AlwaysSpeculatableImplTrait -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface), UnaryEint Effects: MemoryEffects::Effect{} @@ -1483,7 +1479,7 @@ Examples: Traits: AlwaysSpeculatableImplTrait -Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface) +Interfaces: ConditionallySpeculatable, NoMemoryEffect (MemoryEffectOpInterface), UnaryEint Effects: MemoryEffects::Effect{}