Skip to content

Commit

Permalink
chore: prepare release 1.6.0-rc0
Browse files Browse the repository at this point in the history
  • Loading branch information
@RomanBredehoft @github-actions
RomanBredehoft authored and github-actions[bot] committed Jun 20, 2024
1 parent 354d078 commit 951adcd
Show file tree
Hide file tree
Showing 24 changed files with 803 additions and 539 deletions.
4 changes: 4 additions & 0 deletions docs/references/api/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
- [`decoder.ConcreteDecoder`](./concrete.ml.common.serialization.decoder.md#class-concretedecoder): Custom json decoder to handle non-native types found in serialized Concrete ML objects.
- [`encoder.ConcreteEncoder`](./concrete.ml.common.serialization.encoder.md#class-concreteencoder): Custom json encoder to handle non-native types found in serialized Concrete ML objects.
- [`utils.FheMode`](./concrete.ml.common.utils.md#class-fhemode): Enum representing the execution mode.
- [`fhe_client_server.DeploymentMode`](./concrete.ml.deployment.fhe_client_server.md#class-deploymentmode): Mode for the FHE API.
- [`fhe_client_server.FHEModelClient`](./concrete.ml.deployment.fhe_client_server.md#class-fhemodelclient): Client API to encrypt and decrypt FHE data.
- [`fhe_client_server.FHEModelDev`](./concrete.ml.deployment.fhe_client_server.md#class-fhemodeldev): Dev API to save the model and then load and run the FHE circuit.
- [`fhe_client_server.FHEModelServer`](./concrete.ml.deployment.fhe_client_server.md#class-fhemodelserver): Server API to load and run the FHE circuit.
Expand All @@ -84,6 +85,8 @@
- [`torch_models.FCSeq`](./concrete.ml.pytest.torch_models.md#class-fcseq): Torch model that should generate MatMul->Add ONNX patterns.
- [`torch_models.FCSeqAddBiasVec`](./concrete.ml.pytest.torch_models.md#class-fcseqaddbiasvec): Torch model that should generate MatMul->Add ONNX patterns.
- [`torch_models.FCSmall`](./concrete.ml.pytest.torch_models.md#class-fcsmall): Torch model for the tests.
- [`torch_models.IdentityExpandModel`](./concrete.ml.pytest.torch_models.md#class-identityexpandmodel): Model that only adds an empty dimension at axis 0.
- [`torch_models.IdentityExpandMultiOutputModel`](./concrete.ml.pytest.torch_models.md#class-identityexpandmultioutputmodel): Model that only adds an empty dimension at axis 0, and returns the initial input as well.
- [`torch_models.ManualLogisticRegressionTraining`](./concrete.ml.pytest.torch_models.md#class-manuallogisticregressiontraining): PyTorch module for performing SGD training.
- [`torch_models.MultiInputNN`](./concrete.ml.pytest.torch_models.md#class-multiinputnn): Torch model to test multiple inputs forward.
- [`torch_models.MultiInputNNConfigurable`](./concrete.ml.pytest.torch_models.md#class-multiinputnnconfigurable): Torch model to test multiple inputs forward.
Expand Down Expand Up @@ -372,6 +375,7 @@
- [`tree_to_numpy.add_transpose_after_last_node`](./concrete.ml.sklearn.tree_to_numpy.md#function-add_transpose_after_last_node): Add transpose after last node.
- [`tree_to_numpy.assert_add_node_and_constant_in_xgboost_regressor_graph`](./concrete.ml.sklearn.tree_to_numpy.md#function-assert_add_node_and_constant_in_xgboost_regressor_graph): Assert if an Add node with a specific constant exists in the ONNX graph.
- [`tree_to_numpy.get_onnx_model`](./concrete.ml.sklearn.tree_to_numpy.md#function-get_onnx_model): Create ONNX model with Hummingbird convert method.
- [`tree_to_numpy.onnx_fp32_model_to_quantized_model`](./concrete.ml.sklearn.tree_to_numpy.md#function-onnx_fp32_model_to_quantized_model): Build a FHE-compliant onnx-model using a fitted scikit-learn model.
- [`tree_to_numpy.preprocess_tree_predictions`](./concrete.ml.sklearn.tree_to_numpy.md#function-preprocess_tree_predictions): Apply post-processing from the graph.
- [`tree_to_numpy.tree_onnx_graph_preprocessing`](./concrete.ml.sklearn.tree_to_numpy.md#function-tree_onnx_graph_preprocessing): Apply pre-processing onto the ONNX graph.
- [`tree_to_numpy.tree_to_numpy`](./concrete.ml.sklearn.tree_to_numpy.md#function-tree_to_numpy): Convert the tree inference to a numpy functions using Hummingbird.
Expand Down
53 changes: 29 additions & 24 deletions docs/references/api/concrete.ml.common.utils.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Utils that can be re-used by other pieces of code in the module.

______________________________________________________________________

<a href="../../../src/concrete/ml/common/utils.py#L100"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/common/utils.py#L105"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>function</kbd> `replace_invalid_arg_name_chars`

Expand All @@ -39,7 +39,7 @@ This does not check that the starting character of arg_name is valid.

______________________________________________________________________

<a href="../../../src/concrete/ml/common/utils.py#L119"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/common/utils.py#L124"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>function</kbd> `generate_proxy_function`

Expand All @@ -65,7 +65,7 @@ This returns a runtime compiled function with the sanitized argument names passe

______________________________________________________________________

<a href="../../../src/concrete/ml/common/utils.py#L160"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/common/utils.py#L165"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>function</kbd> `get_onnx_opset_version`

Expand All @@ -85,7 +85,7 @@ Return the ONNX opset_version.

______________________________________________________________________

<a href="../../../src/concrete/ml/common/utils.py#L175"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/common/utils.py#L180"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>function</kbd> `manage_parameters_for_pbs_errors`

Expand Down Expand Up @@ -122,7 +122,7 @@ Note that global_p_error is currently set to 0 in the FHE simulation mode.

______________________________________________________________________

<a href="../../../src/concrete/ml/common/utils.py#L220"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/common/utils.py#L225"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>function</kbd> `check_there_is_no_p_error_options_in_configuration`

Expand All @@ -140,7 +140,7 @@ It would be dangerous, since we set them in direct arguments in our calls to Con

______________________________________________________________________

<a href="../../../src/concrete/ml/common/utils.py#L241"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/common/utils.py#L246"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>function</kbd> `get_model_class`

Expand All @@ -159,7 +159,7 @@ The model's class.

______________________________________________________________________

<a href="../../../src/concrete/ml/common/utils.py#L263"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/common/utils.py#L268"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>function</kbd> `is_model_class_in_a_list`

Expand All @@ -179,7 +179,7 @@ If the model's class is in the list or not.

______________________________________________________________________

<a href="../../../src/concrete/ml/common/utils.py#L277"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/common/utils.py#L282"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>function</kbd> `get_model_name`

Expand All @@ -198,7 +198,7 @@ the model's name.

______________________________________________________________________

<a href="../../../src/concrete/ml/common/utils.py#L290"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/common/utils.py#L295"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>function</kbd> `is_classifier_or_partial_classifier`

Expand All @@ -218,7 +218,7 @@ Indicate if the model class represents a classifier.

______________________________________________________________________

<a href="../../../src/concrete/ml/common/utils.py#L302"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/common/utils.py#L307"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>function</kbd> `is_regressor_or_partial_regressor`

Expand All @@ -238,7 +238,7 @@ Indicate if the model class represents a regressor.

______________________________________________________________________

<a href="../../../src/concrete/ml/common/utils.py#L314"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/common/utils.py#L319"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>function</kbd> `is_pandas_dataframe`

Expand All @@ -260,7 +260,7 @@ This function is inspired from Scikit-Learn's test validation tools and avoids t

______________________________________________________________________

<a href="../../../src/concrete/ml/common/utils.py#L330"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/common/utils.py#L335"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>function</kbd> `is_pandas_series`

Expand All @@ -282,7 +282,7 @@ This function is inspired from Scikit-Learn's test validation tools and avoids t

______________________________________________________________________

<a href="../../../src/concrete/ml/common/utils.py#L346"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/common/utils.py#L351"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>function</kbd> `is_pandas_type`

Expand All @@ -302,7 +302,7 @@ Indicate if the input container is a Pandas DataFrame or Series.

______________________________________________________________________

<a href="../../../src/concrete/ml/common/utils.py#L441"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/common/utils.py#L446"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>function</kbd> `check_dtype_and_cast`

Expand Down Expand Up @@ -334,7 +334,7 @@ If values types don't match with any supported type or the expected dtype, raise

______________________________________________________________________

<a href="../../../src/concrete/ml/common/utils.py#L493"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/common/utils.py#L498"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>function</kbd> `compute_bits_precision`

Expand All @@ -354,7 +354,7 @@ Compute the number of bits required to represent x.

______________________________________________________________________

<a href="../../../src/concrete/ml/common/utils.py#L505"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/common/utils.py#L510"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>function</kbd> `is_brevitas_model`

Expand All @@ -374,7 +374,7 @@ Check if a model is a Brevitas type.

______________________________________________________________________

<a href="../../../src/concrete/ml/common/utils.py#L523"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/common/utils.py#L528"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>function</kbd> `to_tuple`

Expand All @@ -394,7 +394,7 @@ Make the input a tuple if it is not already the case.

______________________________________________________________________

<a href="../../../src/concrete/ml/common/utils.py#L539"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/common/utils.py#L544"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>function</kbd> `all_values_are_integers`

Expand All @@ -414,7 +414,7 @@ Indicate if all unpacked values are of a supported integer dtype.

______________________________________________________________________

<a href="../../../src/concrete/ml/common/utils.py#L552"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/common/utils.py#L557"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>function</kbd> `all_values_are_floats`

Expand All @@ -434,12 +434,16 @@ Indicate if all unpacked values are of a supported float dtype.

______________________________________________________________________

<a href="../../../src/concrete/ml/common/utils.py#L565"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/common/utils.py#L570"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>function</kbd> `all_values_are_of_dtype`

```python
all_values_are_of_dtype(*values: Any, dtypes: Union[str, List[str]]) → bool
all_values_are_of_dtype(
*values: Any,
dtypes: Union[str, List[str]],
allow_none: bool = False
) → bool
```

Indicate if all unpacked values are of the specified dtype(s).
Expand All @@ -448,14 +452,15 @@ Indicate if all unpacked values are of the specified dtype(s).

- <b>`*values (Any)`</b>: The values to consider.
- <b>`dtypes`</b> (Union\[str, List\[str\]\]): The dtype(s) to consider.
- <b>`allow_none`</b> (bool): Indicate if the values can be None.

**Returns:**

- <b>`bool`</b>: Whether all values are of the specified dtype(s) or not.

______________________________________________________________________

<a href="../../../src/concrete/ml/common/utils.py#L593"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/common/utils.py#L607"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>function</kbd> `array_allclose_and_same_shape`

Expand Down Expand Up @@ -485,7 +490,7 @@ Check if two numpy arrays are equal within a tolerances and have the same shape.

______________________________________________________________________

<a href="../../../src/concrete/ml/common/utils.py#L617"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/common/utils.py#L631"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>function</kbd> `process_rounding_threshold_bits`

Expand All @@ -511,7 +516,7 @@ Check and process the rounding_threshold_bits parameter.

______________________________________________________________________

<a href="../../../src/concrete/ml/common/utils.py#L57"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/common/utils.py#L62"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>class</kbd> `FheMode`

Expand Down
Loading

0 comments on commit 951adcd

Please sign in to comment.