Skip to content

Commit 4ae5466

Browse files
authored
Documentation update for bootstrappable create-context
1 parent 8db5521 commit 4ae5466

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

utils/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,8 @@ specified then the script will generate a prefix using the name of the
8282
parameter file by default concatenated with a generated number. This file
8383
prefix will be printed to the command line.
8484

85+
The flag `--scheme <default=BGV|CKKS>` will generate the context for BGV or CKKS scheme.
86+
8587
The script will always generate two files (`example.pk` and `example.sk`. They
8688
both hold the serialization of the context and the public key and secret key
8789
respectively.
@@ -91,6 +93,9 @@ the file `example.info`. By default this information is sent to the standard
9193
output however generating the info file is useful for passing to the example
9294
encode decode utilities.
9395

96+
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.
97+
98+
9499
3. Encode some data
95100
```
96101
../coders/encode.py <data-file> example.info <scheme> > example.encoded

0 commit comments

Comments
 (0)