From d6ae00e771e9e831fdf544584963a4a753c5668d Mon Sep 17 00:00:00 2001 From: fd0r Date: Tue, 3 Oct 2023 09:11:15 +0000 Subject: [PATCH] chore: prepare release 1.2.0 --- docs/conf.py | 2 +- docs/developer-guide/api/README.md | 1 - .../api/concrete.ml.common.utils.md | 68 ++++++------------- .../api/concrete.ml.sklearn.base.md | 14 ++-- pyproject.toml | 2 +- src/concrete/ml/version.py | 2 +- 6 files changed, 31 insertions(+), 58 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 9c167cff8..b1429bd67 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -27,7 +27,7 @@ root_url = root_url if root_url.endswith("/") else root_url + "/" # The full version, including alpha/beta/rc tags -release = "1.2.0-rc0" +release = "1.2.0" # -- General configuration --------------------------------------------------- diff --git a/docs/developer-guide/api/README.md b/docs/developer-guide/api/README.md index 7f586a883..e9bc4a324 100644 --- a/docs/developer-guide/api/README.md +++ b/docs/developer-guide/api/README.md @@ -229,7 +229,6 @@ - [`utils.check_dtype_and_cast`](./concrete.ml.common.utils.md#function-check_dtype_and_cast): Convert any allowed type into an array and cast it if required. - [`utils.check_there_is_no_p_error_options_in_configuration`](./concrete.ml.common.utils.md#function-check_there_is_no_p_error_options_in_configuration): Check the user did not set p_error or global_p_error in configuration. - [`utils.compute_bits_precision`](./concrete.ml.common.utils.md#function-compute_bits_precision): Compute the number of bits required to represent x. -- [`utils.force_mono_parameter_in_configuration`](./concrete.ml.common.utils.md#function-force_mono_parameter_in_configuration): Force configuration to mono-parameter strategy. - [`utils.generate_proxy_function`](./concrete.ml.common.utils.md#function-generate_proxy_function): Generate a proxy function for a function accepting only \*args type arguments. - [`utils.get_model_class`](./concrete.ml.common.utils.md#function-get_model_class): Return the class of the model (instantiated or not), which can be a partial() instance. - [`utils.get_model_name`](./concrete.ml.common.utils.md#function-get_model_name): Return the name of the model, which can be a partial() instance. diff --git a/docs/developer-guide/api/concrete.ml.common.utils.md b/docs/developer-guide/api/concrete.ml.common.utils.md index 8e23d06c2..add00f13a 100644 --- a/docs/developer-guide/api/concrete.ml.common.utils.md +++ b/docs/developer-guide/api/concrete.ml.common.utils.md @@ -17,7 +17,7 @@ Utils that can be re-used by other pieces of code in the module. ______________________________________________________________________ - + ## function `replace_invalid_arg_name_chars` @@ -39,7 +39,7 @@ This does not check that the starting character of arg_name is valid. ______________________________________________________________________ - + ## function `generate_proxy_function` @@ -65,7 +65,7 @@ This returns a runtime compiled function with the sanitized argument names passe ______________________________________________________________________ - + ## function `get_onnx_opset_version` @@ -85,7 +85,7 @@ Return the ONNX opset_version. ______________________________________________________________________ - + ## function `manage_parameters_for_pbs_errors` @@ -122,7 +122,7 @@ Note that global_p_error is currently set to 0 in the FHE simulation mode. ______________________________________________________________________ - + ## function `check_there_is_no_p_error_options_in_configuration` @@ -140,7 +140,7 @@ It would be dangerous, since we set them in direct arguments in our calls to Con ______________________________________________________________________ - + ## function `get_model_class` @@ -159,7 +159,7 @@ The model's class. ______________________________________________________________________ - + ## function `is_model_class_in_a_list` @@ -179,7 +179,7 @@ If the model's class is in the list or not. ______________________________________________________________________ - + ## function `get_model_name` @@ -198,7 +198,7 @@ the model's name. ______________________________________________________________________ - + ## function `is_classifier_or_partial_classifier` @@ -218,7 +218,7 @@ Indicate if the model class represents a classifier. ______________________________________________________________________ - + ## function `is_regressor_or_partial_regressor` @@ -238,7 +238,7 @@ Indicate if the model class represents a regressor. ______________________________________________________________________ - + ## function `is_pandas_dataframe` @@ -260,7 +260,7 @@ This function is inspired from Scikit-Learn's test validation tools and avoids t ______________________________________________________________________ - + ## function `is_pandas_series` @@ -282,7 +282,7 @@ This function is inspired from Scikit-Learn's test validation tools and avoids t ______________________________________________________________________ - + ## function `is_pandas_type` @@ -302,7 +302,7 @@ Indicate if the input container is a Pandas DataFrame or Series. ______________________________________________________________________ - + ## function `check_dtype_and_cast` @@ -334,7 +334,7 @@ If values types don't match with any supported type or the expected dtype, raise ______________________________________________________________________ - + ## function `compute_bits_precision` @@ -354,7 +354,7 @@ Compute the number of bits required to represent x. ______________________________________________________________________ - + ## function `is_brevitas_model` @@ -374,7 +374,7 @@ Check if a model is a Brevitas type. ______________________________________________________________________ - + ## function `to_tuple` @@ -394,7 +394,7 @@ Make the input a tuple if it is not already the case. ______________________________________________________________________ - + ## function `all_values_are_integers` @@ -414,7 +414,7 @@ Indicate if all unpacked values are of a supported integer dtype. ______________________________________________________________________ - + ## function `all_values_are_floats` @@ -434,7 +434,7 @@ Indicate if all unpacked values are of a supported float dtype. ______________________________________________________________________ - + ## function `all_values_are_of_dtype` @@ -455,33 +455,7 @@ Indicate if all unpacked values are of the specified dtype(s). ______________________________________________________________________ - - -## function `force_mono_parameter_in_configuration` - -```python -force_mono_parameter_in_configuration( - configuration: Optional[Configuration], - **kwargs -) -``` - -Force configuration to mono-parameter strategy. - -If the given Configuration instance is None, build a new instance with mono-parameter and the additional keyword arguments. - -**Args:** - -- `configuration` (Optional\[Configuration\]): The configuration to consider. -- `**kwargs`: Additional parameters to use for instantiating a new Configuration instance, if configuration is None. - -**Returns:** - -- `configuration` (Configuration): A configuration with mono-parameter strategy. - -______________________________________________________________________ - - + ## class `FheMode` diff --git a/docs/developer-guide/api/concrete.ml.sklearn.base.md b/docs/developer-guide/api/concrete.ml.sklearn.base.md index 2dd6ad569..0d6924ee4 100644 --- a/docs/developer-guide/api/concrete.ml.sklearn.base.md +++ b/docs/developer-guide/api/concrete.ml.sklearn.base.md @@ -3228,7 +3228,7 @@ Check if the model is fitted. ______________________________________________________________________ - + ### method `compile` @@ -3395,7 +3395,7 @@ Determine the most common class among nearest neighborsfor each query. ______________________________________________________________________ - + ### method `post_processing` @@ -3417,7 +3417,7 @@ For KNN, the de-quantization step is not required. Because \_inference returns t ______________________________________________________________________ - + ### method `predict` @@ -3440,7 +3440,7 @@ quantize_input(X: 'ndarray') → ndarray ______________________________________________________________________ - + ## class `SklearnKNeighborsClassifierMixin` @@ -3540,7 +3540,7 @@ Check if the model is fitted. ______________________________________________________________________ - + ### method `compile` @@ -3707,7 +3707,7 @@ Determine the most common class among nearest neighborsfor each query. ______________________________________________________________________ - + ### method `post_processing` @@ -3729,7 +3729,7 @@ For KNN, the de-quantization step is not required. Because \_inference returns t ______________________________________________________________________ - + ### method `predict` diff --git a/pyproject.toml b/pyproject.toml index fa77a1d92..1c51394eb 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "concrete-ml" -version = "1.2.0-rc0" +version = "1.2.0" description = "Concrete ML is an open-source set of tools which aims to simplify the use of fully homomorphic encryption (FHE) for data scientists." license = "BSD-3-Clause-Clear" authors = [ diff --git a/src/concrete/ml/version.py b/src/concrete/ml/version.py index e71631418..78fc8a3cc 100644 --- a/src/concrete/ml/version.py +++ b/src/concrete/ml/version.py @@ -1,3 +1,3 @@ """File to manage the version of the package.""" # Auto-generated by "make set_version" do not modify -__version__ = "1.2.0-rc0" +__version__ = "1.2.0"