diff --git a/docs/developer-guide/api/concrete.ml.onnx.ops_impl.md b/docs/developer-guide/api/concrete.ml.onnx.ops_impl.md index 2278ee8d7..e12e5bece 100644 --- a/docs/developer-guide/api/concrete.ml.onnx.ops_impl.md +++ b/docs/developer-guide/api/concrete.ml.onnx.ops_impl.md @@ -176,7 +176,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Gemm-13 ______________________________________________________________________ - + ## function `numpy_matmul` @@ -199,7 +199,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#MatMul-13 ______________________________________________________________________ - + ## function `numpy_relu` @@ -221,7 +221,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Relu-14 ______________________________________________________________________ - + ## function `numpy_sigmoid` @@ -243,7 +243,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Sigmoid-13 ______________________________________________________________________ - + ## function `numpy_softmax` @@ -269,7 +269,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#softmax-13 ______________________________________________________________________ - + ## function `numpy_cos` @@ -291,7 +291,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Cos-7 ______________________________________________________________________ - + ## function `numpy_cosh` @@ -313,7 +313,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Cosh-9 ______________________________________________________________________ - + ## function `numpy_sin` @@ -335,7 +335,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Sin-7 ______________________________________________________________________ - + ## function `numpy_sinh` @@ -357,7 +357,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Sinh-9 ______________________________________________________________________ - + ## function `numpy_tan` @@ -379,7 +379,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Tan-7 ______________________________________________________________________ - + ## function `numpy_tanh` @@ -401,7 +401,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Tanh-13 ______________________________________________________________________ - + ## function `numpy_acos` @@ -423,7 +423,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Acos-7 ______________________________________________________________________ - + ## function `numpy_acosh` @@ -445,7 +445,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Acosh-9 ______________________________________________________________________ - + ## function `numpy_asin` @@ -467,7 +467,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Asin-7 ______________________________________________________________________ - + ## function `numpy_asinh` @@ -489,7 +489,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Asinh-9 ______________________________________________________________________ - + ## function `numpy_atan` @@ -511,7 +511,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Atan-7 ______________________________________________________________________ - + ## function `numpy_atanh` @@ -533,7 +533,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Atanh-9 ______________________________________________________________________ - + ## function `numpy_elu` @@ -556,7 +556,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Elu-6 ______________________________________________________________________ - + ## function `numpy_selu` @@ -584,7 +584,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Selu-6 ______________________________________________________________________ - + ## function `numpy_celu` @@ -607,7 +607,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Celu-12 ______________________________________________________________________ - + ## function `numpy_leakyrelu` @@ -630,7 +630,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#LeakyRelu-6 ______________________________________________________________________ - + ## function `numpy_thresholdedrelu` @@ -653,7 +653,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#ThresholdedRelu-10 ______________________________________________________________________ - + ## function `numpy_hardsigmoid` @@ -681,7 +681,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#HardSigmoid-6 ______________________________________________________________________ - + ## function `numpy_softplus` @@ -703,7 +703,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Softplus-1 ______________________________________________________________________ - + ## function `numpy_abs` @@ -725,7 +725,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Abs-13 ______________________________________________________________________ - + ## function `numpy_div` @@ -748,7 +748,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Div-14 ______________________________________________________________________ - + ## function `numpy_mul` @@ -771,7 +771,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Mul-14 ______________________________________________________________________ - + ## function `numpy_sub` @@ -794,7 +794,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Sub-14 ______________________________________________________________________ - + ## function `numpy_log` @@ -816,7 +816,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Log-13 ______________________________________________________________________ - + ## function `numpy_erf` @@ -838,7 +838,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Erf-13 ______________________________________________________________________ - + ## function `numpy_hardswish` @@ -860,7 +860,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#hardswish-14 ______________________________________________________________________ - + ## function `numpy_exp` @@ -882,7 +882,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Exp-13 ______________________________________________________________________ - + ## function `numpy_equal` @@ -905,7 +905,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Equal-11 ______________________________________________________________________ - + ## function `rounded_numpy_equal_for_trees` @@ -933,7 +933,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Equal-11 ______________________________________________________________________ - + ## function `numpy_equal_float` @@ -956,7 +956,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Equal-13 ______________________________________________________________________ - + ## function `numpy_not` @@ -978,7 +978,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Not-1 ______________________________________________________________________ - + ## function `numpy_not_float` @@ -1000,7 +1000,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Not-1 ______________________________________________________________________ - + ## function `numpy_greater` @@ -1023,7 +1023,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Greater-13 ______________________________________________________________________ - + ## function `numpy_greater_float` @@ -1046,7 +1046,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Greater-13 ______________________________________________________________________ - + ## function `numpy_greater_or_equal` @@ -1069,7 +1069,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#GreaterOrEqual-12 ______________________________________________________________________ - + ## function `numpy_greater_or_equal_float` @@ -1092,7 +1092,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#GreaterOrEqual-12 ______________________________________________________________________ - + ## function `numpy_less` @@ -1115,7 +1115,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Less-13 ______________________________________________________________________ - + ## function `rounded_numpy_less_for_trees` @@ -1143,7 +1143,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Less-13 ______________________________________________________________________ - + ## function `numpy_less_float` @@ -1166,7 +1166,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Less-13 ______________________________________________________________________ - + ## function `numpy_less_or_equal` @@ -1189,7 +1189,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#LessOrEqual-12 ______________________________________________________________________ - + ## function `rounded_numpy_less_or_equal_for_trees` @@ -1217,7 +1217,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#LessOrEqual-12 ______________________________________________________________________ - + ## function `numpy_less_or_equal_float` @@ -1240,7 +1240,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#LessOrEqual-12 ______________________________________________________________________ - + ## function `numpy_identity` @@ -1262,7 +1262,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Identity-14 ______________________________________________________________________ - + ## function `numpy_transpose` @@ -1285,7 +1285,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Transpose-13 ______________________________________________________________________ - + ## function `numpy_conv` @@ -1326,7 +1326,7 @@ See: https://github.com/onnx/onnx/blob/main/docs/Operators.md#Conv ______________________________________________________________________ - + ## function `numpy_avgpool` @@ -1365,7 +1365,7 @@ See: https://github.com/onnx/onnx/blob/main/docs/Operators.md#AveragePool ______________________________________________________________________ - + ## function `numpy_maxpool` @@ -1406,7 +1406,7 @@ See: https://github.com/onnx/onnx/blob/main/docs/Operators.md#MaxPool ______________________________________________________________________ - + ## function `numpy_cast` @@ -1431,7 +1431,7 @@ See: https://github.com/onnx/onnx/blob/main/docs/Operators.md#Cast ______________________________________________________________________ - + ## function `numpy_batchnorm` @@ -1473,7 +1473,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#BatchNormalization- ______________________________________________________________________ - + ## function `numpy_flatten` @@ -1496,7 +1496,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Flatten-13. ______________________________________________________________________ - + ## function `numpy_or` @@ -1519,7 +1519,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Or-7 ______________________________________________________________________ - + ## function `numpy_or_float` @@ -1542,7 +1542,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Or-7 ______________________________________________________________________ - + ## function `numpy_round` @@ -1564,7 +1564,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Round-11 Remark tha ______________________________________________________________________ - + ## function `numpy_pow` @@ -1587,7 +1587,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Pow-13 ______________________________________________________________________ - + ## function `numpy_floor` @@ -1609,7 +1609,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Floor-1 ______________________________________________________________________ - + ## function `numpy_max` @@ -1634,7 +1634,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Max-1 ______________________________________________________________________ - + ## function `numpy_min` @@ -1659,7 +1659,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Max-1 ______________________________________________________________________ - + ## function `numpy_sign` @@ -1681,7 +1681,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Sign-9 ______________________________________________________________________ - + ## function `numpy_neg` @@ -1703,7 +1703,7 @@ See https://github.com/onnx/onnx/blob/main/docs/Changelog.md#Sign-9 ______________________________________________________________________ - + ## function `numpy_concatenate` diff --git a/docs/developer-guide/api/concrete.ml.quantization.quantized_module.md b/docs/developer-guide/api/concrete.ml.quantization.quantized_module.md index b5ddeb09a..ef7d29d97 100644 --- a/docs/developer-guide/api/concrete.ml.quantization.quantized_module.md +++ b/docs/developer-guide/api/concrete.ml.quantization.quantized_module.md @@ -72,7 +72,7 @@ ______________________________________________________________________ ### method `bitwidth_and_range_report` ```python -bitwidth_and_range_report() → Union[Dict[str, Dict[str, Union[Tuple[int, ], int]]], NoneType] +bitwidth_and_range_report() → Optional[Dict[str, Dict[str, Union[Tuple[int, ], int]]]] ``` Report the ranges and bit-widths for layers that mix encrypted integer values. diff --git a/docs/developer-guide/api/concrete.ml.quantization.quantized_module_passes.md b/docs/developer-guide/api/concrete.ml.quantization.quantized_module_passes.md index 205e213a6..56b77818a 100644 --- a/docs/developer-guide/api/concrete.ml.quantization.quantized_module_passes.md +++ b/docs/developer-guide/api/concrete.ml.quantization.quantized_module_passes.md @@ -41,7 +41,7 @@ ______________________________________________________________________ ### method `compute_op_predecessors` ```python -compute_op_predecessors() → DefaultDict[Union[QuantizedOp, NoneType], List[Tuple[Union[QuantizedOp, NoneType], str]]] +compute_op_predecessors() → DefaultDict[Optional[QuantizedOp], List[Tuple[Optional[QuantizedOp], str]]] ``` Compute the predecessors for each QuantizedOp in a QuantizedModule. @@ -61,7 +61,7 @@ ______________________________________________________________________ ```python detect_patterns( predecessors: DefaultDict[Optional[QuantizedOp], List[Tuple[Optional[QuantizedOp], str]]] -) → Dict[QuantizedMixingOp, Tuple[List[Union[QuantizedOp, NoneType]], Union[QuantizedOp, NoneType]]] +) → Dict[QuantizedMixingOp, Tuple[List[Optional[QuantizedOp]], Optional[QuantizedOp]]] ``` Detect the patterns that can be optimized with roundPBS in the QuantizedModule. @@ -107,7 +107,7 @@ ______________________________________________________________________ ### method `process` ```python -process() → Dict[QuantizedMixingOp, Tuple[List[Union[QuantizedOp, NoneType]], Union[QuantizedOp, NoneType]]] +process() → Dict[QuantizedMixingOp, Tuple[List[Optional[QuantizedOp]], Optional[QuantizedOp]]] ``` Analyze an ONNX graph and detect Gemm/Conv patterns that can use RoundPBS. @@ -129,7 +129,7 @@ ______________________________________________________________________ ```python process_patterns( valid_paths: Dict[QuantizedMixingOp, Tuple[List[Optional[QuantizedOp]], Optional[QuantizedOp]]] -) → Dict[QuantizedMixingOp, Tuple[List[Union[QuantizedOp, NoneType]], Union[QuantizedOp, NoneType]]] +) → Dict[QuantizedMixingOp, Tuple[List[Optional[QuantizedOp]], Optional[QuantizedOp]]] ``` Configure the rounding bits of roundPBS for the optimizable operations. diff --git a/docs/developer-guide/api/concrete.ml.quantization.quantized_ops.md b/docs/developer-guide/api/concrete.ml.quantization.quantized_ops.md index e0e0b23cc..5ef04d265 100644 --- a/docs/developer-guide/api/concrete.ml.quantization.quantized_ops.md +++ b/docs/developer-guide/api/concrete.ml.quantization.quantized_ops.md @@ -340,7 +340,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ### method `can_fuse` @@ -371,7 +371,7 @@ q_impl( ______________________________________________________________________ - + ## class `QuantizedTanh` @@ -389,7 +389,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ## class `QuantizedSoftplus` @@ -407,7 +407,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ## class `QuantizedExp` @@ -425,7 +425,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ## class `QuantizedLog` @@ -443,7 +443,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ## class `QuantizedAbs` @@ -461,7 +461,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ## class `QuantizedIdentity` @@ -479,7 +479,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ### method `q_impl` @@ -492,7 +492,7 @@ q_impl( ______________________________________________________________________ - + ## class `QuantizedReshape` @@ -510,7 +510,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ### method `can_fuse` @@ -528,7 +528,7 @@ Max Pooling operation can not be fused since it must be performed over integer t ______________________________________________________________________ - + ### method `q_impl` @@ -552,13 +552,13 @@ Reshape the input integer encrypted tensor. ______________________________________________________________________ - + ## class `QuantizedConv` Quantized Conv op. - + ### method `__init__` @@ -601,7 +601,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ### method `q_impl` @@ -632,13 +632,13 @@ Allows an optional quantized bias. ______________________________________________________________________ - + ## class `QuantizedAvgPool` Quantized Average Pooling op. - + ### method `__init__` @@ -665,7 +665,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ### method `q_impl` @@ -679,13 +679,13 @@ q_impl( ______________________________________________________________________ - + ## class `QuantizedMaxPool` Quantized Max Pooling op. - + ### method `__init__` @@ -712,7 +712,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ### method `can_fuse` @@ -730,7 +730,7 @@ Max Pooling operation can not be fused since it must be performed over integer t ______________________________________________________________________ - + ### method `q_impl` @@ -743,13 +743,13 @@ q_impl( ______________________________________________________________________ - + ## class `QuantizedPad` Quantized Padding op. - + ### method `__init__` @@ -776,7 +776,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ### method `can_fuse` @@ -794,7 +794,7 @@ Pad operation cannot be fused since it must be performed over integer tensors. ______________________________________________________________________ - + ### method `q_impl` @@ -808,7 +808,7 @@ q_impl( ______________________________________________________________________ - + ## class `QuantizedWhere` @@ -816,7 +816,7 @@ Where operator on quantized arrays. Supports only constants for the results produced on the True/False branches. - + ### method `__init__` @@ -843,7 +843,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ## class `QuantizedCast` @@ -863,7 +863,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ## class `QuantizedGreater` @@ -871,7 +871,7 @@ Comparison operator >. Only supports comparison with a constant. - + ### method `__init__` @@ -898,7 +898,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ## class `QuantizedGreaterOrEqual` @@ -906,7 +906,7 @@ Comparison operator >=. Only supports comparison with a constant. - + ### method `__init__` @@ -933,7 +933,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ## class `QuantizedLess` @@ -941,7 +941,7 @@ Comparison operator \<. Only supports comparison with a constant. - + ### method `__init__` @@ -968,7 +968,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ## class `QuantizedLessOrEqual` @@ -976,7 +976,7 @@ Comparison operator \<=. Only supports comparison with a constant. - + ### method `__init__` @@ -1003,7 +1003,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ## class `QuantizedOr` @@ -1023,7 +1023,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ## class `QuantizedDiv` @@ -1043,7 +1043,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ## class `QuantizedMul` @@ -1063,7 +1063,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ## class `QuantizedSub` @@ -1083,7 +1083,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ### method `can_fuse` @@ -1114,7 +1114,7 @@ q_impl( ______________________________________________________________________ - + ## class `QuantizedBatchNormalization` @@ -1132,7 +1132,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ## class `QuantizedFlatten` @@ -1150,7 +1150,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ### method `can_fuse` @@ -1168,7 +1168,7 @@ Flatten operation cannot be fused since it must be performed over integer tensor ______________________________________________________________________ - + ### method `q_impl` @@ -1192,13 +1192,13 @@ Flatten the input integer encrypted tensor. ______________________________________________________________________ - + ## class `QuantizedReduceSum` ReduceSum with encrypted input. - + ### method `__init__` @@ -1239,7 +1239,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ### method `calibrate` @@ -1259,7 +1259,7 @@ Create corresponding QuantizedArray for the output of the activation function. ______________________________________________________________________ - + ### method `q_impl` @@ -1285,7 +1285,7 @@ Sum the encrypted tensor's values along the given axes. ______________________________________________________________________ - + ## class `QuantizedErf` @@ -1303,7 +1303,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ## class `QuantizedNot` @@ -1321,13 +1321,13 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ## class `QuantizedBrevitasQuant` Brevitas uniform quantization with encrypted input. - + ### method `__init__` @@ -1370,7 +1370,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ### method `calibrate` @@ -1390,7 +1390,7 @@ Create corresponding QuantizedArray for the output of Quantization function. ______________________________________________________________________ - + ### method `q_impl` @@ -1414,7 +1414,7 @@ Quantize values. ______________________________________________________________________ - + ## class `QuantizedTranspose` @@ -1434,7 +1434,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ### method `can_fuse` @@ -1452,7 +1452,7 @@ Transpose can not be fused since it must be performed over integer tensors as it ______________________________________________________________________ - + ### method `q_impl` @@ -1476,7 +1476,7 @@ Transpose the input integer encrypted tensor. ______________________________________________________________________ - + ## class `QuantizedFloor` @@ -1494,7 +1494,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ## class `QuantizedMax` @@ -1512,7 +1512,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ## class `QuantizedMin` @@ -1530,7 +1530,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ## class `QuantizedNeg` @@ -1548,7 +1548,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ## class `QuantizedSign` @@ -1566,7 +1566,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ## class `QuantizedUnsqueeze` @@ -1584,7 +1584,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ### method `can_fuse` @@ -1602,7 +1602,7 @@ Unsqueeze can not be fused since it must be performed over integer tensors as it ______________________________________________________________________ - + ### method `q_impl` @@ -1626,7 +1626,7 @@ Unsqueeze the input tensors on a given axis. ______________________________________________________________________ - + ## class `QuantizedConcat` @@ -1644,7 +1644,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ### method `can_fuse` @@ -1662,7 +1662,7 @@ Concatenation can not be fused since it must be performed over integer tensors a ______________________________________________________________________ - + ### method `q_impl` @@ -1686,7 +1686,7 @@ Concatenate the input tensors on a given axis. ______________________________________________________________________ - + ## class `QuantizedSqueeze` @@ -1704,7 +1704,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ### method `can_fuse` @@ -1722,7 +1722,7 @@ Squeeze can not be fused since it must be performed over integer tensors as it r ______________________________________________________________________ - + ### method `q_impl` @@ -1746,7 +1746,7 @@ Squeeze the input tensors on a given axis. ______________________________________________________________________ - + ## class `ONNXShape` @@ -1764,7 +1764,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ### method `can_fuse` @@ -1782,7 +1782,7 @@ This operation returns the shape of the tensor and thus can not be fused into a ______________________________________________________________________ - + ### method `q_impl` @@ -1795,7 +1795,7 @@ q_impl( ______________________________________________________________________ - + ## class `ONNXConstantOfShape` @@ -1813,7 +1813,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ### method `can_fuse` @@ -1831,7 +1831,7 @@ This operation returns a new encrypted tensor and thus can not be fused. ______________________________________________________________________ - + ## class `ONNXGather` @@ -1851,7 +1851,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ### method `can_fuse` @@ -1869,7 +1869,7 @@ This operation returns values from a tensor and thus can not be fused into a uni ______________________________________________________________________ - + ### method `q_impl` @@ -1882,7 +1882,7 @@ q_impl( ______________________________________________________________________ - + ## class `ONNXSlice` @@ -1900,7 +1900,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ### method `can_fuse` @@ -1918,7 +1918,7 @@ This operation returns values from a tensor and thus can not be fused into a uni ______________________________________________________________________ - + ### method `q_impl` @@ -1931,7 +1931,7 @@ q_impl( ______________________________________________________________________ - + ## class `QuantizedExpand` @@ -1949,7 +1949,7 @@ Get the names of encrypted integer tensors that are used by this op. ______________________________________________________________________ - + ### method `can_fuse` @@ -1967,7 +1967,7 @@ Unsqueeze can not be fused since it must be performed over integer tensors as it ______________________________________________________________________ - + ### method `q_impl` @@ -1991,7 +1991,7 @@ Expand the input tensor to a specified shape. ______________________________________________________________________ - + ## class `QuantizedEqual` @@ -1999,7 +1999,7 @@ Comparison operator ==. Only supports comparison with a constant. - + ### method `__init__` diff --git a/docs/developer-guide/api/concrete.ml.sklearn.base.md b/docs/developer-guide/api/concrete.ml.sklearn.base.md index 6afe5c111..ebb110c2a 100644 --- a/docs/developer-guide/api/concrete.ml.sklearn.base.md +++ b/docs/developer-guide/api/concrete.ml.sklearn.base.md @@ -14,7 +14,7 @@ Base classes for all estimators. ______________________________________________________________________ - + ## class `BaseEstimator` @@ -26,7 +26,7 @@ This class does not inherit from sklearn.base.BaseEstimator as it creates some c - `_is_a_public_cml_model` (bool): Private attribute indicating if the class is a public model (as opposed to base or mixin classes). - + ### method `__init__` @@ -84,7 +84,7 @@ Is None if the model is not fitted. ______________________________________________________________________ - + ### method `check_model_is_compiled` @@ -100,7 +100,7 @@ Check if the model is compiled. ______________________________________________________________________ - + ### method `check_model_is_fitted` @@ -116,7 +116,7 @@ Check if the model is fitted. ______________________________________________________________________ - + ### method `compile` @@ -150,7 +150,7 @@ Compile the model. ______________________________________________________________________ - + ### method `dequantize_output` @@ -172,7 +172,7 @@ This step ensures that the fit method has been called. ______________________________________________________________________ - + ### method `dump` @@ -188,7 +188,7 @@ Dump itself to a file. ______________________________________________________________________ - + ### method `dump_dict` @@ -204,7 +204,7 @@ Dump the object as a dict. ______________________________________________________________________ - + ### method `dumps` @@ -220,7 +220,7 @@ Dump itself to a string. ______________________________________________________________________ - + ### method `fit` @@ -243,7 +243,7 @@ The fitted estimator. ______________________________________________________________________ - + ### method `fit_benchmark` @@ -270,7 +270,7 @@ The Concrete ML and float equivalent fitted estimators. ______________________________________________________________________ - + ### method `get_sklearn_params` @@ -292,7 +292,7 @@ This method is used to instantiate a scikit-learn model using the Concrete ML mo ______________________________________________________________________ - + ### classmethod `load_dict` @@ -312,7 +312,7 @@ Load itself from a dict. ______________________________________________________________________ - + ### method `post_processing` @@ -336,7 +336,7 @@ For some simple models such a linear regression, there is no post-processing ste ______________________________________________________________________ - + ### method `predict` @@ -360,7 +360,7 @@ Predict values for X, in FHE or in the clear. ______________________________________________________________________ - + ### method `quantize_input` @@ -382,7 +382,7 @@ This step ensures that the fit method has been called. ______________________________________________________________________ - + ## class `BaseClassifier` @@ -390,7 +390,7 @@ Base class for linear and tree-based classifiers in Concrete ML. This class inherits from BaseEstimator and modifies some of its methods in order to align them with classifier behaviors. This notably include applying a sigmoid/softmax post-processing to the predicted values as well as handling a mapping of classes in case they are not ordered. - + ### method `__init__` @@ -472,7 +472,7 @@ Using this attribute is deprecated. ______________________________________________________________________ - + ### method `check_model_is_compiled` @@ -488,7 +488,7 @@ Check if the model is compiled. ______________________________________________________________________ - + ### method `check_model_is_fitted` @@ -504,7 +504,7 @@ Check if the model is fitted. ______________________________________________________________________ - + ### method `compile` @@ -538,7 +538,7 @@ Compile the model. ______________________________________________________________________ - + ### method `dequantize_output` @@ -560,7 +560,7 @@ This step ensures that the fit method has been called. ______________________________________________________________________ - + ### method `dump` @@ -576,7 +576,7 @@ Dump itself to a file. ______________________________________________________________________ - + ### method `dump_dict` @@ -592,7 +592,7 @@ Dump the object as a dict. ______________________________________________________________________ - + ### method `dumps` @@ -608,7 +608,7 @@ Dump itself to a string. ______________________________________________________________________ - + ### method `fit` @@ -618,7 +618,7 @@ fit(X: 'Data', y: 'Target', **fit_parameters) ______________________________________________________________________ - + ### method `fit_benchmark` @@ -645,7 +645,7 @@ The Concrete ML and float equivalent fitted estimators. ______________________________________________________________________ - + ### method `get_sklearn_params` @@ -667,7 +667,7 @@ This method is used to instantiate a scikit-learn model using the Concrete ML mo ______________________________________________________________________ - + ### classmethod `load_dict` @@ -687,7 +687,7 @@ Load itself from a dict. ______________________________________________________________________ - + ### method `post_processing` @@ -697,7 +697,7 @@ post_processing(y_preds: 'ndarray') → ndarray ______________________________________________________________________ - + ### method `predict` @@ -710,7 +710,7 @@ predict( ______________________________________________________________________ - + ### method `predict_proba` @@ -734,7 +734,7 @@ Predict class probabilities. ______________________________________________________________________ - + ### method `quantize_input` @@ -756,13 +756,13 @@ This step ensures that the fit method has been called. ______________________________________________________________________ - + ## class `QuantizedTorchEstimatorMixin` Mixin that provides quantization for a torch module and follows the Estimator API. - + ### method `__init__` @@ -838,7 +838,7 @@ Get the output quantizers. ______________________________________________________________________ - + ### method `check_model_is_compiled` @@ -854,7 +854,7 @@ Check if the model is compiled. ______________________________________________________________________ - + ### method `check_model_is_fitted` @@ -870,7 +870,7 @@ Check if the model is fitted. ______________________________________________________________________ - + ### method `compile` @@ -888,7 +888,7 @@ compile( ______________________________________________________________________ - + ### method `dequantize_output` @@ -898,7 +898,7 @@ dequantize_output(*q_y_preds: 'ndarray') → ndarray ______________________________________________________________________ - + ### method `dump` @@ -914,7 +914,7 @@ Dump itself to a file. ______________________________________________________________________ - + ### method `dump_dict` @@ -930,7 +930,7 @@ Dump the object as a dict. ______________________________________________________________________ - + ### method `dumps` @@ -946,7 +946,7 @@ Dump itself to a string. ______________________________________________________________________ - + ### method `fit` @@ -971,7 +971,7 @@ The fitted estimator. ______________________________________________________________________ - + ### method `fit_benchmark` @@ -1002,7 +1002,7 @@ The Concrete ML and equivalent skorch fitted estimators. ______________________________________________________________________ - + ### method `get_params` @@ -1024,7 +1024,7 @@ This method is overloaded in order to make sure that auto-computed parameters ar ______________________________________________________________________ - + ### method `get_sklearn_params` @@ -1034,7 +1034,7 @@ get_sklearn_params(deep: 'bool' = True) → Dict ______________________________________________________________________ - + ### classmethod `load_dict` @@ -1054,7 +1054,7 @@ Load itself from a dict. ______________________________________________________________________ - + ### method `post_processing` @@ -1064,7 +1064,7 @@ post_processing(y_preds: 'ndarray') → ndarray ______________________________________________________________________ - + ### method `predict` @@ -1088,7 +1088,7 @@ Predict values for X, in FHE or in the clear. ______________________________________________________________________ - + ### method `prune` @@ -1116,7 +1116,7 @@ A new pruned copy of the Neural Network model. ______________________________________________________________________ - + ### method `quantize_input` @@ -1126,7 +1126,7 @@ quantize_input(X: 'ndarray') → ndarray ______________________________________________________________________ - + ## class `BaseTreeEstimatorMixin` @@ -1134,7 +1134,7 @@ Mixin class for tree-based estimators. This class inherits from sklearn.base.BaseEstimator in order to have access to scikit-learn's `get_params` and `set_params` methods. - + ### method `__init__` @@ -1194,7 +1194,7 @@ Is None if the model is not fitted. ______________________________________________________________________ - + ### method `check_model_is_compiled` @@ -1210,7 +1210,7 @@ Check if the model is compiled. ______________________________________________________________________ - + ### method `check_model_is_fitted` @@ -1226,7 +1226,7 @@ Check if the model is fitted. ______________________________________________________________________ - + ### method `compile` @@ -1236,7 +1236,7 @@ compile(*args, **kwargs) → Circuit ______________________________________________________________________ - + ### method `dequantize_output` @@ -1246,7 +1246,7 @@ dequantize_output(q_y_preds: 'ndarray') → ndarray ______________________________________________________________________ - + ### method `dump` @@ -1262,7 +1262,7 @@ Dump itself to a file. ______________________________________________________________________ - + ### method `dump_dict` @@ -1278,7 +1278,7 @@ Dump the object as a dict. ______________________________________________________________________ - + ### method `dumps` @@ -1294,7 +1294,7 @@ Dump itself to a string. ______________________________________________________________________ - + ### method `fit` @@ -1304,7 +1304,7 @@ fit(X: 'Data', y: 'Target', **fit_parameters) ______________________________________________________________________ - + ### method `fit_benchmark` @@ -1331,7 +1331,7 @@ The Concrete ML and float equivalent fitted estimators. ______________________________________________________________________ - + ### method `get_sklearn_params` @@ -1353,7 +1353,7 @@ This method is used to instantiate a scikit-learn model using the Concrete ML mo ______________________________________________________________________ - + ### classmethod `load_dict` @@ -1373,7 +1373,7 @@ Load itself from a dict. ______________________________________________________________________ - + ### method `post_processing` @@ -1383,7 +1383,7 @@ post_processing(y_preds: 'ndarray') → ndarray ______________________________________________________________________ - + ### method `predict` @@ -1396,7 +1396,7 @@ predict( ______________________________________________________________________ - + ### method `quantize_input` @@ -1406,7 +1406,7 @@ quantize_input(X: 'ndarray') → ndarray ______________________________________________________________________ - + ## class `BaseTreeRegressorMixin` @@ -1414,7 +1414,7 @@ Mixin class for tree-based regressors. This class is used to create a tree-based regressor class that inherits from sklearn.base.RegressorMixin, which essentially gives access to scikit-learn's `score` method for regressors. - + ### method `__init__` @@ -1474,7 +1474,7 @@ Is None if the model is not fitted. ______________________________________________________________________ - + ### method `check_model_is_compiled` @@ -1490,7 +1490,7 @@ Check if the model is compiled. ______________________________________________________________________ - + ### method `check_model_is_fitted` @@ -1506,7 +1506,7 @@ Check if the model is fitted. ______________________________________________________________________ - + ### method `compile` @@ -1516,7 +1516,7 @@ compile(*args, **kwargs) → Circuit ______________________________________________________________________ - + ### method `dequantize_output` @@ -1526,7 +1526,7 @@ dequantize_output(q_y_preds: 'ndarray') → ndarray ______________________________________________________________________ - + ### method `dump` @@ -1542,7 +1542,7 @@ Dump itself to a file. ______________________________________________________________________ - + ### method `dump_dict` @@ -1558,7 +1558,7 @@ Dump the object as a dict. ______________________________________________________________________ - + ### method `dumps` @@ -1574,7 +1574,7 @@ Dump itself to a string. ______________________________________________________________________ - + ### method `fit` @@ -1584,7 +1584,7 @@ fit(X: 'Data', y: 'Target', **fit_parameters) ______________________________________________________________________ - + ### method `fit_benchmark` @@ -1611,7 +1611,7 @@ The Concrete ML and float equivalent fitted estimators. ______________________________________________________________________ - + ### method `get_sklearn_params` @@ -1633,7 +1633,7 @@ This method is used to instantiate a scikit-learn model using the Concrete ML mo ______________________________________________________________________ - + ### classmethod `load_dict` @@ -1653,7 +1653,7 @@ Load itself from a dict. ______________________________________________________________________ - + ### method `post_processing` @@ -1663,7 +1663,7 @@ post_processing(y_preds: 'ndarray') → ndarray ______________________________________________________________________ - + ### method `predict` @@ -1676,7 +1676,7 @@ predict( ______________________________________________________________________ - + ### method `quantize_input` @@ -1686,7 +1686,7 @@ quantize_input(X: 'ndarray') → ndarray ______________________________________________________________________ - + ## class `BaseTreeClassifierMixin` @@ -1696,7 +1696,7 @@ This class is used to create a tree-based classifier class that inherits from sk Additionally, this class adjusts some of the tree-based base class's methods in order to make them compliant with classification workflows. - + ### method `__init__` @@ -1780,7 +1780,7 @@ Using this attribute is deprecated. ______________________________________________________________________ - + ### method `check_model_is_compiled` @@ -1796,7 +1796,7 @@ Check if the model is compiled. ______________________________________________________________________ - + ### method `check_model_is_fitted` @@ -1812,7 +1812,7 @@ Check if the model is fitted. ______________________________________________________________________ - + ### method `compile` @@ -1822,7 +1822,7 @@ compile(*args, **kwargs) → Circuit ______________________________________________________________________ - + ### method `dequantize_output` @@ -1832,7 +1832,7 @@ dequantize_output(q_y_preds: 'ndarray') → ndarray ______________________________________________________________________ - + ### method `dump` @@ -1848,7 +1848,7 @@ Dump itself to a file. ______________________________________________________________________ - + ### method `dump_dict` @@ -1864,7 +1864,7 @@ Dump the object as a dict. ______________________________________________________________________ - + ### method `dumps` @@ -1880,7 +1880,7 @@ Dump itself to a string. ______________________________________________________________________ - + ### method `fit` @@ -1890,7 +1890,7 @@ fit(X: 'Data', y: 'Target', **fit_parameters) ______________________________________________________________________ - + ### method `fit_benchmark` @@ -1917,7 +1917,7 @@ The Concrete ML and float equivalent fitted estimators. ______________________________________________________________________ - + ### method `get_sklearn_params` @@ -1939,7 +1939,7 @@ This method is used to instantiate a scikit-learn model using the Concrete ML mo ______________________________________________________________________ - + ### classmethod `load_dict` @@ -1959,7 +1959,7 @@ Load itself from a dict. ______________________________________________________________________ - + ### method `post_processing` @@ -1969,7 +1969,7 @@ post_processing(y_preds: 'ndarray') → ndarray ______________________________________________________________________ - + ### method `predict` @@ -1982,7 +1982,7 @@ predict( ______________________________________________________________________ - + ### method `predict_proba` @@ -2006,7 +2006,7 @@ Predict class probabilities. ______________________________________________________________________ - + ### method `quantize_input` @@ -2016,7 +2016,7 @@ quantize_input(X: 'ndarray') → ndarray ______________________________________________________________________ - + ## class `SklearnLinearModelMixin` @@ -2024,7 +2024,7 @@ A Mixin class for sklearn linear models with FHE. This class inherits from sklearn.base.BaseEstimator in order to have access to scikit-learn's `get_params` and `set_params` methods. - + ### method `__init__` @@ -2086,7 +2086,7 @@ Is None if the model is not fitted. ______________________________________________________________________ - + ### method `check_model_is_compiled` @@ -2102,7 +2102,7 @@ Check if the model is compiled. ______________________________________________________________________ - + ### method `check_model_is_fitted` @@ -2118,7 +2118,7 @@ Check if the model is fitted. ______________________________________________________________________ - + ### method `compile` @@ -2152,7 +2152,7 @@ Compile the model. ______________________________________________________________________ - + ### method `dequantize_output` @@ -2162,7 +2162,7 @@ dequantize_output(q_y_preds: 'ndarray') → ndarray ______________________________________________________________________ - + ### method `dump` @@ -2178,7 +2178,7 @@ Dump itself to a file. ______________________________________________________________________ - + ### method `dump_dict` @@ -2194,7 +2194,7 @@ Dump the object as a dict. ______________________________________________________________________ - + ### method `dumps` @@ -2210,7 +2210,7 @@ Dump itself to a string. ______________________________________________________________________ - + ### method `fit` @@ -2220,7 +2220,7 @@ fit(X: 'Data', y: 'Target', **fit_parameters) ______________________________________________________________________ - + ### method `fit_benchmark` @@ -2247,7 +2247,7 @@ The Concrete ML and float equivalent fitted estimators. ______________________________________________________________________ - + ### classmethod `from_sklearn_model` @@ -2274,7 +2274,7 @@ The FHE-compliant fitted model. ______________________________________________________________________ - + ### method `get_sklearn_params` @@ -2296,7 +2296,7 @@ This method is used to instantiate a scikit-learn model using the Concrete ML mo ______________________________________________________________________ - + ### classmethod `load_dict` @@ -2316,7 +2316,7 @@ Load itself from a dict. ______________________________________________________________________ - + ### method `post_processing` @@ -2340,7 +2340,7 @@ For some simple models such a linear regression, there is no post-processing ste ______________________________________________________________________ - + ### method `predict` @@ -2364,7 +2364,7 @@ Predict values for X, in FHE or in the clear. ______________________________________________________________________ - + ### method `quantize_input` @@ -2374,7 +2374,7 @@ quantize_input(X: 'ndarray') → ndarray ______________________________________________________________________ - + ## class `SklearnLinearRegressorMixin` @@ -2382,7 +2382,7 @@ A Mixin class for sklearn linear regressors with FHE. This class is used to create a linear regressor class that inherits from sklearn.base.RegressorMixin, which essentially gives access to scikit-learn's `score` method for regressors. - + ### method `__init__` @@ -2444,7 +2444,7 @@ Is None if the model is not fitted. ______________________________________________________________________ - + ### method `check_model_is_compiled` @@ -2460,7 +2460,7 @@ Check if the model is compiled. ______________________________________________________________________ - + ### method `check_model_is_fitted` @@ -2476,7 +2476,7 @@ Check if the model is fitted. ______________________________________________________________________ - + ### method `compile` @@ -2510,7 +2510,7 @@ Compile the model. ______________________________________________________________________ - + ### method `dequantize_output` @@ -2520,7 +2520,7 @@ dequantize_output(q_y_preds: 'ndarray') → ndarray ______________________________________________________________________ - + ### method `dump` @@ -2536,7 +2536,7 @@ Dump itself to a file. ______________________________________________________________________ - + ### method `dump_dict` @@ -2552,7 +2552,7 @@ Dump the object as a dict. ______________________________________________________________________ - + ### method `dumps` @@ -2568,7 +2568,7 @@ Dump itself to a string. ______________________________________________________________________ - + ### method `fit` @@ -2578,7 +2578,7 @@ fit(X: 'Data', y: 'Target', **fit_parameters) ______________________________________________________________________ - + ### method `fit_benchmark` @@ -2605,7 +2605,7 @@ The Concrete ML and float equivalent fitted estimators. ______________________________________________________________________ - + ### classmethod `from_sklearn_model` @@ -2632,7 +2632,7 @@ The FHE-compliant fitted model. ______________________________________________________________________ - + ### method `get_sklearn_params` @@ -2654,7 +2654,7 @@ This method is used to instantiate a scikit-learn model using the Concrete ML mo ______________________________________________________________________ - + ### classmethod `load_dict` @@ -2674,7 +2674,7 @@ Load itself from a dict. ______________________________________________________________________ - + ### method `post_processing` @@ -2698,7 +2698,7 @@ For some simple models such a linear regression, there is no post-processing ste ______________________________________________________________________ - + ### method `predict` @@ -2722,7 +2722,7 @@ Predict values for X, in FHE or in the clear. ______________________________________________________________________ - + ### method `quantize_input` @@ -2732,7 +2732,7 @@ quantize_input(X: 'ndarray') → ndarray ______________________________________________________________________ - + ## class `SklearnSGDRegressorMixin` @@ -2740,7 +2740,7 @@ A Mixin class for sklearn SGD regressors with FHE. This class is used to create a SGD regressor class what can be exported to ONNX using Hummingbird. - + ### method `__init__` @@ -2802,7 +2802,7 @@ Is None if the model is not fitted. ______________________________________________________________________ - + ### method `check_model_is_compiled` @@ -2818,7 +2818,7 @@ Check if the model is compiled. ______________________________________________________________________ - + ### method `check_model_is_fitted` @@ -2834,7 +2834,7 @@ Check if the model is fitted. ______________________________________________________________________ - + ### method `compile` @@ -2868,7 +2868,7 @@ Compile the model. ______________________________________________________________________ - + ### method `dequantize_output` @@ -2878,7 +2878,7 @@ dequantize_output(q_y_preds: 'ndarray') → ndarray ______________________________________________________________________ - + ### method `dump` @@ -2894,7 +2894,7 @@ Dump itself to a file. ______________________________________________________________________ - + ### method `dump_dict` @@ -2910,7 +2910,7 @@ Dump the object as a dict. ______________________________________________________________________ - + ### method `dumps` @@ -2926,7 +2926,7 @@ Dump itself to a string. ______________________________________________________________________ - + ### method `fit` @@ -2936,7 +2936,7 @@ fit(X: 'Data', y: 'Target', **fit_parameters) ______________________________________________________________________ - + ### method `fit_benchmark` @@ -2963,7 +2963,7 @@ The Concrete ML and float equivalent fitted estimators. ______________________________________________________________________ - + ### classmethod `from_sklearn_model` @@ -2990,7 +2990,7 @@ The FHE-compliant fitted model. ______________________________________________________________________ - + ### method `get_sklearn_params` @@ -3012,7 +3012,7 @@ This method is used to instantiate a scikit-learn model using the Concrete ML mo ______________________________________________________________________ - + ### classmethod `load_dict` @@ -3032,7 +3032,7 @@ Load itself from a dict. ______________________________________________________________________ - + ### method `post_processing` @@ -3056,7 +3056,7 @@ For some simple models such a linear regression, there is no post-processing ste ______________________________________________________________________ - + ### method `predict` @@ -3080,7 +3080,7 @@ Predict values for X, in FHE or in the clear. ______________________________________________________________________ - + ### method `quantize_input` @@ -3090,7 +3090,7 @@ quantize_input(X: 'ndarray') → ndarray ______________________________________________________________________ - + ## class `SklearnLinearClassifierMixin` @@ -3100,7 +3100,7 @@ This class is used to create a linear classifier class that inherits from sklear Additionally, this class adjusts some of the tree-based base class's methods in order to make them compliant with classification workflows. - + ### method `__init__` @@ -3186,7 +3186,7 @@ Using this attribute is deprecated. ______________________________________________________________________ - + ### method `check_model_is_compiled` @@ -3202,7 +3202,7 @@ Check if the model is compiled. ______________________________________________________________________ - + ### method `check_model_is_fitted` @@ -3218,7 +3218,7 @@ Check if the model is fitted. ______________________________________________________________________ - + ### method `compile` @@ -3252,7 +3252,7 @@ Compile the model. ______________________________________________________________________ - + ### method `decision_function` @@ -3276,7 +3276,7 @@ Predict confidence scores. ______________________________________________________________________ - + ### method `dequantize_output` @@ -3286,7 +3286,7 @@ dequantize_output(q_y_preds: 'ndarray') → ndarray ______________________________________________________________________ - + ### method `dump` @@ -3302,7 +3302,7 @@ Dump itself to a file. ______________________________________________________________________ - + ### method `dump_dict` @@ -3318,7 +3318,7 @@ Dump the object as a dict. ______________________________________________________________________ - + ### method `dumps` @@ -3334,7 +3334,7 @@ Dump itself to a string. ______________________________________________________________________ - + ### method `fit` @@ -3344,7 +3344,7 @@ fit(X: 'Data', y: 'Target', **fit_parameters) ______________________________________________________________________ - + ### method `fit_benchmark` @@ -3371,7 +3371,7 @@ The Concrete ML and float equivalent fitted estimators. ______________________________________________________________________ - + ### classmethod `from_sklearn_model` @@ -3398,7 +3398,7 @@ The FHE-compliant fitted model. ______________________________________________________________________ - + ### method `get_sklearn_params` @@ -3420,7 +3420,7 @@ This method is used to instantiate a scikit-learn model using the Concrete ML mo ______________________________________________________________________ - + ### classmethod `load_dict` @@ -3440,7 +3440,7 @@ Load itself from a dict. ______________________________________________________________________ - + ### method `post_processing` @@ -3450,7 +3450,7 @@ post_processing(y_preds: 'ndarray') → ndarray ______________________________________________________________________ - + ### method `predict` @@ -3463,7 +3463,7 @@ predict( ______________________________________________________________________ - + ### method `predict_proba` @@ -3476,7 +3476,7 @@ predict_proba( ______________________________________________________________________ - + ### method `quantize_input` @@ -3486,7 +3486,7 @@ quantize_input(X: 'ndarray') → ndarray ______________________________________________________________________ - + ## class `SklearnSGDClassifierMixin` @@ -3494,7 +3494,7 @@ A Mixin class for sklearn SGD classifiers with FHE. This class is used to create a SGD classifier class what can be exported to ONNX using Hummingbird. - + ### method `__init__` @@ -3580,7 +3580,7 @@ Using this attribute is deprecated. ______________________________________________________________________ - + ### method `check_model_is_compiled` @@ -3596,7 +3596,7 @@ Check if the model is compiled. ______________________________________________________________________ - + ### method `check_model_is_fitted` @@ -3612,7 +3612,7 @@ Check if the model is fitted. ______________________________________________________________________ - + ### method `compile` @@ -3646,7 +3646,7 @@ Compile the model. ______________________________________________________________________ - + ### method `decision_function` @@ -3670,7 +3670,7 @@ Predict confidence scores. ______________________________________________________________________ - + ### method `dequantize_output` @@ -3680,7 +3680,7 @@ dequantize_output(q_y_preds: 'ndarray') → ndarray ______________________________________________________________________ - + ### method `dump` @@ -3696,7 +3696,7 @@ Dump itself to a file. ______________________________________________________________________ - + ### method `dump_dict` @@ -3712,7 +3712,7 @@ Dump the object as a dict. ______________________________________________________________________ - + ### method `dumps` @@ -3728,7 +3728,7 @@ Dump itself to a string. ______________________________________________________________________ - + ### method `fit` @@ -3738,7 +3738,7 @@ fit(X: 'Data', y: 'Target', **fit_parameters) ______________________________________________________________________ - + ### method `fit_benchmark` @@ -3765,7 +3765,7 @@ The Concrete ML and float equivalent fitted estimators. ______________________________________________________________________ - + ### classmethod `from_sklearn_model` @@ -3792,7 +3792,7 @@ The FHE-compliant fitted model. ______________________________________________________________________ - + ### method `get_sklearn_params` @@ -3814,7 +3814,7 @@ This method is used to instantiate a scikit-learn model using the Concrete ML mo ______________________________________________________________________ - + ### classmethod `load_dict` @@ -3834,7 +3834,7 @@ Load itself from a dict. ______________________________________________________________________ - + ### method `post_processing` @@ -3844,7 +3844,7 @@ post_processing(y_preds: 'ndarray') → ndarray ______________________________________________________________________ - + ### method `predict` @@ -3857,7 +3857,7 @@ predict( ______________________________________________________________________ - + ### method `predict_proba` @@ -3870,7 +3870,7 @@ predict_proba( ______________________________________________________________________ - + ### method `quantize_input` @@ -3880,7 +3880,7 @@ quantize_input(X: 'ndarray') → ndarray ______________________________________________________________________ - + ## class `SklearnKNeighborsMixin` @@ -3888,7 +3888,7 @@ A Mixin class for sklearn KNeighbors models with FHE. This class inherits from sklearn.base.BaseEstimator in order to have access to scikit-learn's `get_params` and `set_params` methods. - + ### method `__init__` @@ -3948,7 +3948,7 @@ Is None if the model is not fitted. ______________________________________________________________________ - + ### method `check_model_is_compiled` @@ -3964,7 +3964,7 @@ Check if the model is compiled. ______________________________________________________________________ - + ### method `check_model_is_fitted` @@ -3980,7 +3980,7 @@ Check if the model is fitted. ______________________________________________________________________ - + ### method `compile` @@ -4014,7 +4014,7 @@ Compile the model. ______________________________________________________________________ - + ### method `dequantize_output` @@ -4024,7 +4024,7 @@ dequantize_output(q_y_preds: 'ndarray') → ndarray ______________________________________________________________________ - + ### method `dump` @@ -4040,7 +4040,7 @@ Dump itself to a file. ______________________________________________________________________ - + ### method `dump_dict` @@ -4056,7 +4056,7 @@ Dump the object as a dict. ______________________________________________________________________ - + ### method `dumps` @@ -4072,7 +4072,7 @@ Dump itself to a string. ______________________________________________________________________ - + ### method `fit` @@ -4082,7 +4082,7 @@ fit(X: 'Data', y: 'Target', **fit_parameters) ______________________________________________________________________ - + ### method `fit_benchmark` @@ -4109,7 +4109,7 @@ The Concrete ML and float equivalent fitted estimators. ______________________________________________________________________ - + ### method `get_sklearn_params` @@ -4131,7 +4131,7 @@ This method is used to instantiate a scikit-learn model using the Concrete ML mo ______________________________________________________________________ - + ### method `get_topk_labels` @@ -4155,7 +4155,7 @@ Return the K-nearest labels of each point. ______________________________________________________________________ - + ### classmethod `load_dict` @@ -4175,7 +4175,7 @@ Load itself from a dict. ______________________________________________________________________ - + ### method `majority_vote` @@ -4195,7 +4195,7 @@ Determine the most common class among nearest neighborsfor each query. ______________________________________________________________________ - + ### method `post_processing` @@ -4217,7 +4217,7 @@ For KNN, the de-quantization step is not required. Because \_inference returns t ______________________________________________________________________ - + ### method `predict` @@ -4230,7 +4230,7 @@ predict( ______________________________________________________________________ - + ### method `quantize_input` @@ -4240,7 +4240,7 @@ quantize_input(X: 'ndarray') → ndarray ______________________________________________________________________ - + ## class `SklearnKNeighborsClassifierMixin` @@ -4248,7 +4248,7 @@ A Mixin class for sklearn KNeighbors classifiers with FHE. This class is used to create a KNeighbors classifier class that inherits from SklearnKNeighborsMixin and sklearn.base.ClassifierMixin. By inheriting from sklearn.base.ClassifierMixin, it allows this class to be recognized as a classifier." - + ### method `__init__` @@ -4308,7 +4308,7 @@ Is None if the model is not fitted. ______________________________________________________________________ - + ### method `check_model_is_compiled` @@ -4324,7 +4324,7 @@ Check if the model is compiled. ______________________________________________________________________ - + ### method `check_model_is_fitted` @@ -4340,7 +4340,7 @@ Check if the model is fitted. ______________________________________________________________________ - + ### method `compile` @@ -4374,7 +4374,7 @@ Compile the model. ______________________________________________________________________ - + ### method `dequantize_output` @@ -4384,7 +4384,7 @@ dequantize_output(q_y_preds: 'ndarray') → ndarray ______________________________________________________________________ - + ### method `dump` @@ -4400,7 +4400,7 @@ Dump itself to a file. ______________________________________________________________________ - + ### method `dump_dict` @@ -4416,7 +4416,7 @@ Dump the object as a dict. ______________________________________________________________________ - + ### method `dumps` @@ -4432,7 +4432,7 @@ Dump itself to a string. ______________________________________________________________________ - + ### method `fit` @@ -4442,7 +4442,7 @@ fit(X: 'Data', y: 'Target', **fit_parameters) ______________________________________________________________________ - + ### method `fit_benchmark` @@ -4469,7 +4469,7 @@ The Concrete ML and float equivalent fitted estimators. ______________________________________________________________________ - + ### method `get_sklearn_params` @@ -4491,7 +4491,7 @@ This method is used to instantiate a scikit-learn model using the Concrete ML mo ______________________________________________________________________ - + ### method `get_topk_labels` @@ -4515,7 +4515,7 @@ Return the K-nearest labels of each point. ______________________________________________________________________ - + ### classmethod `load_dict` @@ -4535,7 +4535,7 @@ Load itself from a dict. ______________________________________________________________________ - + ### method `majority_vote` @@ -4555,7 +4555,7 @@ Determine the most common class among nearest neighborsfor each query. ______________________________________________________________________ - + ### method `post_processing` @@ -4577,7 +4577,7 @@ For KNN, the de-quantization step is not required. Because \_inference returns t ______________________________________________________________________ - + ### method `predict` @@ -4590,7 +4590,7 @@ predict( ______________________________________________________________________ - + ### method `quantize_input`