github/concrete
1
1
Fork 0
mirror of https://github.com/zama-ai/concrete.git synced 2026-02-08 19:44:57 -05:00
Code Issues Packages Projects Releases Wiki Activity

fix: use less confusing defaults for p error configurations

Browse Source
This commit is contained in:
Umut
2023-01-05 13:02:40 +01:00
parent 0c470852c3
commit 0c4dbe7e8e
6 changed files with 23 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/getting-started/exactness.md
View File

@@ -18,7 +18,7 @@ However, if you set `global_p_error` to `0.01`, the whole circuit will have 1% p
If you set both of them, both will be satisfied. Essentially, the stricter one will be used.
By default, `p_error` is set to `None` and `global_p_error` is set to `1 / 100_000`. Feel free to play with these configuration options to pick the one best suited for your needs! For example, in some machine learning use cases, off-by-one or off-by-two errors doesn't affect the result much, in such cases `p_error` could be set to increase performance without losing accuracy.
By default, both `p_error` and `global_p_error` is set to `None`, which results in `global_p_error` of `1 / 100_000` being used. Feel free to play with these configuration options to pick the one best suited for your needs! For example, in some machine learning use cases, off-by-one or off-by-two errors doesn't affect the result much, in such cases `p_error` could be set to increase performance without losing accuracy.
See [How to Configure](../howto/configure.md) to learn how you can set a custom `p_error` and/or `global_p_error`.

6
docs/howto/configure.md
View File

@@ -74,10 +74,10 @@ Additional kwarg to `compile` function have higher precedence. So if you set an
* Whether to adjust rounders automatically.
* **p_error**: Optional[float] = None
* Error probability for individual table lookups. If set, all table lookups will have the probability of non-exact result smaller than the set value.
* Error probability for individual table lookups. If set, all table lookups will have the probability of non-exact result smaller than the set value. See [Exactness](../getting-started/exactness.md) to learn more.
* **global_p_error**: Optional[float] = (1 / 100_000)
* Global error probability for the whole circuit. If set, the whole circuit will have the probability of non-exact result smaller than the set value.
* **global_p_error**: Optional[float] = None
* Global error probability for the whole circuit. If set, the whole circuit will have the probability of non-exact result smaller than the set value. See [Exactness](../getting-started/exactness.md) to learn more.
* **jit**: bool = False
* Whether to use JIT compilation.