Skip to content

Commit

Permalink
chore: prepare release 1.4.0-rc2
Browse files Browse the repository at this point in the history
  • Loading branch information
@fd0r
fd0r committed Jan 5, 2024
1 parent 0893718 commit 534199c
Show file tree
Hide file tree
Showing 6 changed files with 43 additions and 48 deletions.
2 changes: 1 addition & 1 deletion docs/conf.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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 ---------------------------------------------------
Expand Down
6 changes: 3 additions & 3 deletions docs/developer-guide/api/concrete.ml.quantization.quantized_module.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,13 @@ QuantizedModule API.

______________________________________________________________________

<a href="../../../src/concrete/ml/quantization/quantized_module.py#L83"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/quantization/quantized_module.py#L82"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>class</kbd> `QuantizedModule`

Inference for a quantized model.

<a href="../../../src/concrete/ml/quantization/quantized_module.py#L93"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/quantization/quantized_module.py#L92"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>method</kbd> `__init__`

Expand Down Expand Up @@ -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.
73 changes: 34 additions & 39 deletions docs/developer-guide/api/concrete.ml.sklearn.linear_model.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,9 @@

Implement sklearn linear model.

## **Global Variables**

- **N_BITS_TRAINING_LOWER_BOUND**
- **ROUNDING_TRAINING_LOWER_BOUND**

______________________________________________________________________

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L31"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L29"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>class</kbd> `LinearRegression`

Expand All @@ -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

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L51"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L49"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>method</kbd> `__init__`

Expand Down Expand Up @@ -88,7 +83,7 @@ Is None if the model is not fitted.

______________________________________________________________________

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L69"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L67"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>method</kbd> `dump_dict`

Expand All @@ -98,7 +93,7 @@ dump_dict() → Dict[str, Any]

______________________________________________________________________

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L96"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L94"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>classmethod</kbd> `load_dict`

Expand All @@ -108,7 +103,7 @@ load_dict(metadata: Dict)

______________________________________________________________________

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

## <kbd>class</kbd> `SGDClassifier`

Expand All @@ -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

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L154"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L150"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>method</kbd> `__init__`

Expand Down Expand Up @@ -228,7 +223,7 @@ Using this attribute is deprecated.

______________________________________________________________________

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L978"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L954"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>method</kbd> `dump_dict`

Expand All @@ -238,7 +233,7 @@ dump_dict() → Dict[str, Any]

______________________________________________________________________

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

### <kbd>method</kbd> `fit`

Expand Down Expand Up @@ -274,12 +269,12 @@ The fitted estimator.

**Raises:**

- <b>`ValueError`</b>: If the given 'fhe' parameter is not coherent with 'fit_encrypted'
- <b>`ValueError`</b>: if `fhe` is provided but `fit_encrypted==False`
- <b>`NotImplementedError`</b>: If parameter a 'sample_weight' is given while FHE training is enabled.

______________________________________________________________________

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L281"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L278"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>method</kbd> `get_sklearn_params`

Expand All @@ -289,7 +284,7 @@ get_sklearn_params(deep: bool = True) → dict

______________________________________________________________________

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1036"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1011"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>classmethod</kbd> `load_dict`

Expand All @@ -299,7 +294,7 @@ load_dict(metadata: Dict)

______________________________________________________________________

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L829"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L808"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>method</kbd> `partial_fit`

Expand All @@ -323,7 +318,7 @@ This function does one iteration of SGD training. Looping n_times over this func

______________________________________________________________________

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L260"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L257"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>method</kbd> `post_processing`

Expand All @@ -333,7 +328,7 @@ post_processing(y_preds: ndarray) → ndarray

______________________________________________________________________

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L893"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L872"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>method</kbd> `predict_proba`

Expand Down Expand Up @@ -373,7 +368,7 @@ The justification for the formula in the loss="modified_huber" case is in the ap

______________________________________________________________________

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1100"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1074"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>class</kbd> `SGDRegressor`

Expand All @@ -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

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1120"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1094"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>method</kbd> `__init__`

Expand Down Expand Up @@ -462,7 +457,7 @@ Is None if the model is not fitted.

______________________________________________________________________

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1167"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1141"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>method</kbd> `dump_dict`

Expand All @@ -472,7 +467,7 @@ dump_dict() → Dict[str, Any]

______________________________________________________________________

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1208"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1182"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>classmethod</kbd> `load_dict`

Expand All @@ -482,7 +477,7 @@ load_dict(metadata: Dict)

______________________________________________________________________

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1249"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1223"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>class</kbd> `ElasticNet`

Expand All @@ -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

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1269"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1243"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>method</kbd> `__init__`

Expand Down Expand Up @@ -564,7 +559,7 @@ Is None if the model is not fitted.

______________________________________________________________________

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1301"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1275"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>method</kbd> `dump_dict`

Expand All @@ -574,7 +569,7 @@ dump_dict() → Dict[str, Any]

______________________________________________________________________

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1335"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1309"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>classmethod</kbd> `load_dict`

Expand All @@ -584,7 +579,7 @@ load_dict(metadata: Dict)

______________________________________________________________________

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1370"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1344"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>class</kbd> `Lasso`

Expand All @@ -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

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1390"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1364"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>method</kbd> `__init__`

Expand Down Expand Up @@ -665,7 +660,7 @@ Is None if the model is not fitted.

______________________________________________________________________

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1420"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1394"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>method</kbd> `dump_dict`

Expand All @@ -675,7 +670,7 @@ dump_dict() → Dict[str, Any]

______________________________________________________________________

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1453"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1427"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>classmethod</kbd> `load_dict`

Expand All @@ -685,7 +680,7 @@ load_dict(metadata: Dict)

______________________________________________________________________

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1487"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1461"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>class</kbd> `Ridge`

Expand All @@ -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

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1507"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1481"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>method</kbd> `__init__`

Expand Down Expand Up @@ -764,7 +759,7 @@ Is None if the model is not fitted.

______________________________________________________________________

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1533"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1507"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>method</kbd> `dump_dict`

Expand All @@ -774,7 +769,7 @@ dump_dict() → Dict[str, Any]

______________________________________________________________________

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1564"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1538"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>classmethod</kbd> `load_dict`

Expand All @@ -784,7 +779,7 @@ load_dict(metadata: Dict)

______________________________________________________________________

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1595"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1569"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

## <kbd>class</kbd> `LogisticRegression`

Expand All @@ -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

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1615"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1589"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>method</kbd> `__init__`

Expand Down Expand Up @@ -893,7 +888,7 @@ Using this attribute is deprecated.

______________________________________________________________________

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1655"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1629"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>method</kbd> `dump_dict`

Expand All @@ -903,7 +898,7 @@ dump_dict() → Dict[str, Any]

______________________________________________________________________

<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1692"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/linear_model.py#L1666"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

### <kbd>classmethod</kbd> `load_dict`

Expand Down
Loading

0 comments on commit 534199c

Please sign in to comment.