Skip to content

Commit

Permalink
chore: prepare release 1.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@fd0r
fd0r committed Oct 3, 2023
1 parent a69b21a commit 68f860b
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 58 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.2.0-rc0"
release = "1.2.0"


# -- General configuration ---------------------------------------------------
Expand Down
1 change: 0 additions & 1 deletion docs/developer-guide/api/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
68 changes: 21 additions & 47 deletions docs/developer-guide/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#L96"><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#L94"><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#L115"><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#L113"><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#L156"><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#L154"><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#L171"><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#L169"><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#L216"><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#L214"><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#L237"><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#L235"><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#L259"><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#L257"><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#L273"><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#L271"><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#L286"><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#L284"><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#L298"><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#L296"><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#L310"><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#L308"><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#L326"><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#L324"><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#L342"><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#L340"><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#L437"><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#L435"><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#L489"><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#L487"><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#L501"><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#L499"><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#L519"><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#L517"><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#L535"><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#L533"><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#L548"><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#L546"><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,7 +434,7 @@ Indicate if all unpacked values are of a supported float dtype.

______________________________________________________________________

<a href="../../../src/concrete/ml/common/utils.py#L561"><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#L559"><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`

Expand All @@ -455,33 +455,7 @@ Indicate if all unpacked values are of the specified dtype(s).

______________________________________________________________________

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

## <kbd>function</kbd> `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:**

- <b>`configuration`</b> (Optional\[Configuration\]): The configuration to consider.
- <b>`**kwargs`</b>: Additional parameters to use for instantiating a new Configuration instance, if configuration is None.

**Returns:**

- <b>`configuration`</b> (Configuration): A configuration with mono-parameter strategy.

______________________________________________________________________

<a href="../../../src/concrete/ml/common/utils.py#L53"><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#L51"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>

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

Expand Down
14 changes: 7 additions & 7 deletions docs/developer-guide/api/concrete.ml.sklearn.base.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3228,7 +3228,7 @@ Check if the model is fitted.

______________________________________________________________________

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

### <kbd>method</kbd> `compile`

Expand Down Expand Up @@ -3395,7 +3395,7 @@ Determine the most common class among nearest neighborsfor each query.

______________________________________________________________________

<a href="../../../src/concrete/ml/sklearn/base.py#L2084"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/base.py#L2071"><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 @@ -3417,7 +3417,7 @@ For KNN, the de-quantization step is not required. Because \_inference returns t

______________________________________________________________________

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

### <kbd>method</kbd> `predict`

Expand All @@ -3440,7 +3440,7 @@ quantize_input(X: 'ndarray') → ndarray

______________________________________________________________________

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

## <kbd>class</kbd> `SklearnKNeighborsClassifierMixin`

Expand Down Expand Up @@ -3540,7 +3540,7 @@ Check if the model is fitted.

______________________________________________________________________

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

### <kbd>method</kbd> `compile`

Expand Down Expand Up @@ -3707,7 +3707,7 @@ Determine the most common class among nearest neighborsfor each query.

______________________________________________________________________

<a href="../../../src/concrete/ml/sklearn/base.py#L2084"><img align="right" style="float:right;" src="https://img.shields.io/badge/-source-cccccc?style=flat-square"></a>
<a href="../../../src/concrete/ml/sklearn/base.py#L2071"><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 @@ -3729,7 +3729,7 @@ For KNN, the de-quantization step is not required. Because \_inference returns t

______________________________________________________________________

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

### <kbd>method</kbd> `predict`

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
View file
Original file line number Diff line number Diff line change
@@ -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 = [
Expand Down
2 changes: 1 addition & 1 deletion src/concrete/ml/version.py
View file
Original file line number Diff line number Diff line change
@@ -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"

0 comments on commit 68f860b

Please sign in to comment.