Skip to content

Commit

Permalink
Documentation update for bootstrappable create-context
Browse files Browse the repository at this point in the history
  • Loading branch information
sajetan authored Dec 2, 2022
1 parent 8db5521 commit 4ae5466
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions utils/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,8 @@ specified then the script will generate a prefix using the name of the
parameter file by default concatenated with a generated number. This file
prefix will be printed to the command line.

The flag `--scheme <default=BGV|CKKS>` will generate the context for BGV or CKKS scheme.

The script will always generate two files (`example.pk` and `example.sk`. They
both hold the serialization of the context and the public key and secret key
respectively.
Expand All @@ -91,6 +93,9 @@ the file `example.info`. By default this information is sent to the standard
output however generating the info file is useful for passing to the example
encode decode utilities.

The flag `--bootstrap <default=NONE|THIN|THICK>` can be used enable the bootstrapping with THIN or THICK bootstrapping options, this will generate the required bootstrappable context with key-switching matrices, frobenius matrices and bootstrapping keys, which are added to the `*.pk` and `*.sk` files respectivey. If this flag is enabled while using the BGV scheme, it needs three additional parameters (mvec, gens, ords) which are formatted as space-separated list added to the parameter file.


3. Encode some data
```
../coders/encode.py <data-file> example.info <scheme> > example.encoded
Expand Down

0 comments on commit 4ae5466

Please sign in to comment.