From 534199cf762a3561e078d0cf5fcf500e2797efb5 Mon Sep 17 00:00:00 2001 From: fd0r Date: Thu, 4 Jan 2024 22:34:46 +0000 Subject: [PATCH] chore: prepare release 1.4.0-rc2 --- docs/conf.py | 2 +- ...ncrete.ml.quantization.quantized_module.md | 6 +- .../api/concrete.ml.sklearn.linear_model.md | 73 +++++++++---------- .../api/concrete.ml.torch.compile.md | 6 +- pyproject.toml | 2 +- src/concrete/ml/version.py | 2 +- 6 files changed, 43 insertions(+), 48 deletions(-) diff --git a/docs/conf.py b/docs/conf.py index 10839a8dc..7513c03b7 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.4.0-rc1" +release = "1.4.0-rc2" # -- General configuration --------------------------------------------------- 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 c3a499ca6..b5ddeb09a 100644 --- a/docs/developer-guide/api/concrete.ml.quantization.quantized_module.md +++ b/docs/developer-guide/api/concrete.ml.quantization.quantized_module.md @@ -14,13 +14,13 @@ QuantizedModule API. ______________________________________________________________________ - + ## class `QuantizedModule` Inference for a quantized model. - + ### method `__init__` @@ -347,4 +347,4 @@ set_reduce_sum_copy() Set reduce sum to copy or not the inputs. -Due to bit-width propagation in the compilation we might or not want to copy the inputs with a PBS to avoid it. +Due to bit-width propagation in the compilation we need, in some situations, to copy the inputs with a PBS to avoid it. diff --git a/docs/developer-guide/api/concrete.ml.sklearn.linear_model.md b/docs/developer-guide/api/concrete.ml.sklearn.linear_model.md index 39a503f53..68fa38e31 100644 --- a/docs/developer-guide/api/concrete.ml.sklearn.linear_model.md +++ b/docs/developer-guide/api/concrete.ml.sklearn.linear_model.md @@ -6,14 +6,9 @@ Implement sklearn linear model. -## **Global Variables** - -- **N_BITS_TRAINING_LOWER_BOUND** -- **ROUNDING_TRAINING_LOWER_BOUND** - ______________________________________________________________________ - + ## class `LinearRegression` @@ -27,7 +22,7 @@ A linear regression model with FHE. For more details on LinearRegression please refer to the scikit-learn documentation: https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LinearRegression.html - + ### method `__init__` @@ -88,7 +83,7 @@ Is None if the model is not fitted. ______________________________________________________________________ - + ### method `dump_dict` @@ -98,7 +93,7 @@ dump_dict() → Dict[str, Any] ______________________________________________________________________ - + ### classmethod `load_dict` @@ -108,7 +103,7 @@ load_dict(metadata: Dict) ______________________________________________________________________ - + ## class `SGDClassifier` @@ -125,7 +120,7 @@ An FHE linear classifier model fitted with stochastic gradient descent. For more details on SGDClassifier please refer to the scikit-learn documentation: https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.SGDClassifier.html - + ### method `__init__` @@ -228,7 +223,7 @@ Using this attribute is deprecated. ______________________________________________________________________ - + ### method `dump_dict` @@ -238,7 +233,7 @@ dump_dict() → Dict[str, Any] ______________________________________________________________________ - + ### method `fit` @@ -274,12 +269,12 @@ The fitted estimator. **Raises:** -- `ValueError`: If the given 'fhe' parameter is not coherent with 'fit_encrypted' +- `ValueError`: if `fhe` is provided but `fit_encrypted==False` - `NotImplementedError`: If parameter a 'sample_weight' is given while FHE training is enabled. ______________________________________________________________________ - + ### method `get_sklearn_params` @@ -289,7 +284,7 @@ get_sklearn_params(deep: bool = True) → dict ______________________________________________________________________ - + ### classmethod `load_dict` @@ -299,7 +294,7 @@ load_dict(metadata: Dict) ______________________________________________________________________ - + ### method `partial_fit` @@ -323,7 +318,7 @@ This function does one iteration of SGD training. Looping n_times over this func ______________________________________________________________________ - + ### method `post_processing` @@ -333,7 +328,7 @@ post_processing(y_preds: ndarray) → ndarray ______________________________________________________________________ - + ### method `predict_proba` @@ -373,7 +368,7 @@ The justification for the formula in the loss="modified_huber" case is in the ap ______________________________________________________________________ - + ## class `SGDRegressor` @@ -387,7 +382,7 @@ An FHE linear regression model fitted with stochastic gradient descent. For more details on SGDRegressor please refer to the scikit-learn documentation: https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.SGDRegressor.html - + ### method `__init__` @@ -462,7 +457,7 @@ Is None if the model is not fitted. ______________________________________________________________________ - + ### method `dump_dict` @@ -472,7 +467,7 @@ dump_dict() → Dict[str, Any] ______________________________________________________________________ - + ### classmethod `load_dict` @@ -482,7 +477,7 @@ load_dict(metadata: Dict) ______________________________________________________________________ - + ## class `ElasticNet` @@ -496,7 +491,7 @@ An ElasticNet regression model with FHE. For more details on ElasticNet please refer to the scikit-learn documentation: https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.ElasticNet.html - + ### method `__init__` @@ -564,7 +559,7 @@ Is None if the model is not fitted. ______________________________________________________________________ - + ### method `dump_dict` @@ -574,7 +569,7 @@ dump_dict() → Dict[str, Any] ______________________________________________________________________ - + ### classmethod `load_dict` @@ -584,7 +579,7 @@ load_dict(metadata: Dict) ______________________________________________________________________ - + ## class `Lasso` @@ -598,7 +593,7 @@ A Lasso regression model with FHE. For more details on Lasso please refer to the scikit-learn documentation: https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.Lasso.html - + ### method `__init__` @@ -665,7 +660,7 @@ Is None if the model is not fitted. ______________________________________________________________________ - + ### method `dump_dict` @@ -675,7 +670,7 @@ dump_dict() → Dict[str, Any] ______________________________________________________________________ - + ### classmethod `load_dict` @@ -685,7 +680,7 @@ load_dict(metadata: Dict) ______________________________________________________________________ - + ## class `Ridge` @@ -699,7 +694,7 @@ A Ridge regression model with FHE. For more details on Ridge please refer to the scikit-learn documentation: https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.Ridge.html - + ### method `__init__` @@ -764,7 +759,7 @@ Is None if the model is not fitted. ______________________________________________________________________ - + ### method `dump_dict` @@ -774,7 +769,7 @@ dump_dict() → Dict[str, Any] ______________________________________________________________________ - + ### classmethod `load_dict` @@ -784,7 +779,7 @@ load_dict(metadata: Dict) ______________________________________________________________________ - + ## class `LogisticRegression` @@ -798,7 +793,7 @@ A logistic regression model with FHE. For more details on LogisticRegression please refer to the scikit-learn documentation: https://scikit-learn.org/stable/modules/generated/sklearn.linear_model.LogisticRegression.html - + ### method `__init__` @@ -893,7 +888,7 @@ Using this attribute is deprecated. ______________________________________________________________________ - + ### method `dump_dict` @@ -903,7 +898,7 @@ dump_dict() → Dict[str, Any] ______________________________________________________________________ - + ### classmethod `load_dict` diff --git a/docs/developer-guide/api/concrete.ml.torch.compile.md b/docs/developer-guide/api/concrete.ml.torch.compile.md index 2efbdc70b..92875e204 100644 --- a/docs/developer-guide/api/concrete.ml.torch.compile.md +++ b/docs/developer-guide/api/concrete.ml.torch.compile.md @@ -91,7 +91,7 @@ Take a model in torch or ONNX, turn it to numpy, quantize its inputs / weights / ______________________________________________________________________ - + ## function `compile_torch_model` @@ -139,7 +139,7 @@ Take a model in torch, turn it to numpy, quantize its inputs / weights / outputs ______________________________________________________________________ - + ## function `compile_onnx_model` @@ -187,7 +187,7 @@ Take a model in torch, turn it to numpy, quantize its inputs / weights / outputs ______________________________________________________________________ - + ## function `compile_brevitas_qat_model` diff --git a/pyproject.toml b/pyproject.toml index da570c70b..da73d8a27 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "concrete-ml" -version = "1.4.0-rc1" +version = "1.4.0-rc2" 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 911e64daf..490422995 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.4.0-rc1" +__version__ = "1.4.0-rc2"