Skip to content

Commit

Permalink
chore: prepare release 1.6.1
Browse files Browse the repository at this point in the history
  • Loading branch information
@fd0r
fd0r committed Jun 28, 2024
1 parent 1e07dbf commit 8681124
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 31 deletions.
58 changes: 29 additions & 29 deletions docs/references/api/concrete.ml.torch.hybrid_model.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ Implement the conversion of a torch model to a hybrid fhe/torch inference.

______________________________________________________________________

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

## <kbd>function</kbd> `tuple_to_underscore_str`

Expand All @@ -32,7 +32,7 @@ Convert a tuple to a string representation.

______________________________________________________________________

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

## <kbd>function</kbd> `underscore_str_to_tuple`

Expand All @@ -52,7 +52,7 @@ Convert a a string representation of a tuple to a tuple.

______________________________________________________________________

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

## <kbd>function</kbd> `convert_conv1d_to_linear`

Expand All @@ -72,21 +72,21 @@ Convert all Conv1D layers in a module or a Conv1D layer itself to nn.Linear.

______________________________________________________________________

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

## <kbd>class</kbd> `HybridFHEMode`

Simple enum for different modes of execution of HybridModel.

______________________________________________________________________

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

## <kbd>class</kbd> `RemoteModule`

A wrapper class for the modules to be evaluated remotely with FHE.

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

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

Expand All @@ -102,7 +102,7 @@ __init__(

______________________________________________________________________

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

### <kbd>method</kbd> `forward`

Expand Down Expand Up @@ -133,7 +133,7 @@ To change the behavior of this forward function one must change the fhe_local_mo

______________________________________________________________________

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

### <kbd>method</kbd> `init_fhe_client`

Expand All @@ -157,7 +157,7 @@ Set the clients keys.

______________________________________________________________________

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

### <kbd>method</kbd> `remote_call`

Expand All @@ -177,7 +177,7 @@ Call the remote server to get the private module inference.

______________________________________________________________________

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

## <kbd>class</kbd> `HybridFHEModel`

Expand All @@ -193,7 +193,7 @@ This is done by converting targeted modules by RemoteModules. This will modify t
- <b>`model_name`</b> (str): Model name identifier
- <b>`verbose`</b> (int): If logs should be printed when interacting with FHE server

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

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

Expand All @@ -209,7 +209,7 @@ __init__(

______________________________________________________________________

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

### <kbd>method</kbd> `compile_model`

Expand All @@ -235,7 +235,7 @@ Compiles the specific layers to FHE.

______________________________________________________________________

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

### <kbd>method</kbd> `init_client`

Expand All @@ -255,7 +255,7 @@ Initialize client for all remote modules.

______________________________________________________________________

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

### <kbd>method</kbd> `publish_to_hub`

Expand All @@ -267,7 +267,7 @@ Allow the user to push the model and FHE required files to HF Hub.

______________________________________________________________________

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

### <kbd>method</kbd> `save_and_clear_private_info`

Expand All @@ -284,7 +284,7 @@ Save the PyTorch model to the provided path and also saves the corresponding FHE

______________________________________________________________________

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

### <kbd>method</kbd> `set_fhe_mode`

Expand All @@ -300,15 +300,15 @@ Set Hybrid FHE mode for all remote modules.

______________________________________________________________________

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

## <kbd>class</kbd> `LoggerStub`

Placeholder type for a typical logger like the one from loguru.

______________________________________________________________________

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

### <kbd>method</kbd> `info`

Expand All @@ -324,15 +324,15 @@ Placholder function for logger.info.

______________________________________________________________________

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

## <kbd>class</kbd> `HybridFHEModelServer`

Hybrid FHE Model Server.

This is a class object to server FHE models serialized using HybridFHEModel.

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

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

Expand All @@ -342,7 +342,7 @@ __init__(key_path: Path, model_dir: Path, logger: Optional[LoggerStub])

______________________________________________________________________

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

### <kbd>method</kbd> `add_key`

Expand All @@ -365,7 +365,7 @@ Dict\[str, str\]

______________________________________________________________________

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

### <kbd>method</kbd> `check_inputs`

Expand All @@ -391,7 +391,7 @@ Check that the given configuration exist in the compiled models folder.

______________________________________________________________________

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

### <kbd>method</kbd> `compute`

Expand Down Expand Up @@ -421,7 +421,7 @@ Compute the circuit over encrypted input.

______________________________________________________________________

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

### <kbd>method</kbd> `dump_key`

Expand All @@ -438,7 +438,7 @@ Dump a public key to a stream.

______________________________________________________________________

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

### <kbd>method</kbd> `get_circuit`

Expand All @@ -460,7 +460,7 @@ Get circuit based on model name, module name and input shape.

______________________________________________________________________

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

### <kbd>method</kbd> `get_client`

Expand All @@ -486,7 +486,7 @@ Get client.

______________________________________________________________________

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

### <kbd>method</kbd> `list_modules`

Expand All @@ -505,7 +505,7 @@ Dict\[str, Dict\[str, Dict\]\]

______________________________________________________________________

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

### <kbd>method</kbd> `list_shapes`

Expand All @@ -525,7 +525,7 @@ Dict\[str, Dict\]

______________________________________________________________________

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

### <kbd>method</kbd> `load_key`

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.6.0"
version = "1.6.1"
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,4 +1,4 @@
"""File to manage the version of the package."""

# Auto-generated by "make set_version" do not modify
__version__ = "1.6.0"
__version__ = "1.6.1"

0 comments on commit 8681124

Please sign in to comment.