fix/improve docs #540

mayeul-zama · 2023-09-11T14:59:51Z

No description provided.

github-actions · 2023-09-11T15:00:04Z

@slab-ci cpu_fast_test

tfhe/docs/application_tutorials/dark_market.md

tfhe/docs/fine_grained_api/Boolean/readme.md

tfhe/docs/how_to/parallelized_pbs.md

tfhe/docs/tutorials/ascii_fhe_string.md

IceTDrinker · 2023-09-11T15:06:48Z

tfhe/examples/dark_market/main.rs

@@ -0,0 +1,111 @@
+use std::time::Instant;


dark market changes are just file reorgs ?

In the second commit, yes, its mostly file reorgs plus closure converted to static functions for readability
The last commit is a formula change for the improved parallelized version

did you check the updated function works as expected ?

Yes (expect for the last test case which is very slow), I just had to fix an underflow which got caught in devo profile

github-actions · 2023-09-11T15:59:21Z

@slab-ci cpu_fast_test

github-actions · 2023-09-11T16:02:49Z

@slab-ci cpu_fast_test

github-actions · 2023-09-12T12:00:24Z

@slab-ci cpu_fast_test

github-actions · 2023-09-13T08:23:55Z

@slab-ci cpu_fast_test

codecov · 2023-09-13T09:09:08Z

Codecov Report

Merging #540 (a0fb04b) into main (ed83fbb) will increase coverage by 0.16%.
Report is 6 commits behind head on main.
The diff coverage is n/a.

❗ Current head a0fb04b differs from pull request most recent head 065d415. Consider uploading reports for the commit 065d415 to get more accurate results

@@            Coverage Diff             @@
##             main     #540      +/-   ##
==========================================
+ Coverage   23.11%   23.28%   +0.16%     
==========================================
  Files         256      255       -1     
  Lines       19573    19536      -37     
==========================================
+ Hits         4525     4549      +24     
+ Misses      15048    14987      -61

see 18 files with indirect coverage changes

github-actions · 2023-09-13T12:26:32Z

@slab-ci cpu_fast_test

tmontaigu · 2023-09-13T15:33:07Z

tfhe/docs/how_to/compress.md

@@ -3,6 +3,7 @@ TFHE-rs includes features to reduce the size of both keys and ciphertexts, by co

 In the library, entities that can be compressed are prefixed by `Compressed`. For instance, the type of a compressed `FheUint256` is `CompressedFheUint256`.

+In the following example code, we use the `bincode` crate dependency to compare serialized sizes.


phrasing may make it seems like bincode only serves too compare serialized sizes,

In the following example code, we use the `bincode` crate dependency to serialize in a binary format and compare serialized sizes.

tfhe/docs/how_to/compress.md

tfhe/docs/tutorials/ascii_fhe_string.md

github-actions · 2023-09-13T17:42:42Z

@slab-ci cpu_fast_test

tfhe/docs/application_tutorials/dark_market.md

tfhe/docs/tutorials/ascii_fhe_string.md

IceTDrinker · 2023-09-13T13:30:39Z

tfhe/docs/tutorials/ascii_fhe_string.md

+
+* The input string can only contain ascii characters.
+
+It is not possible to create branches where the condition if an encrypted integer, meaning the function cannot use conditional statements.


where the condition if ? the sentence looks odd

also now we have if_then_else that does basically what the code describe, maybe the correct way of writing it is to say "it is not possible to branch on an encrypted value, however it is possible to evaluate a boolean condition and output the proper result" or something along those lines ?

follow up issue for updating the code to use if_then_else

https://github.com/zama-ai/tfhe-rs-internal/issues/236

github-actions · 2023-09-14T15:35:57Z

@slab-ci cpu_fast_test
@slab-ci code_coverage

github-actions · 2023-09-15T07:56:45Z

Pull Request has been approved 🎉
Launching full test suite...
@slab-ci cpu_test
@slab-ci cpu_integer_test
@slab-ci cpu_multi_bit_test
@slab-ci cpu_wasm_test
@slab-ci csprng_randomness_testing

IceTDrinker · 2023-09-18T07:41:40Z

fine to merge if you had time to check the updated code is valid

mayeul-zama · 2023-09-18T07:57:57Z

fine to merge if you had time to check the updated code is valid

Yes, I tested it manually in a AWS instance

cla-bot bot added the cla-signed label Sep 11, 2023

mayeul-zama requested a review from IceTDrinker September 11, 2023 15:00

mayeul-zama assigned tmontaigu Sep 11, 2023

IceTDrinker reviewed Sep 11, 2023

View reviewed changes

mayeul-zama force-pushed the mz/docs/improve branch from 4792c1a to bdb1467 Compare September 11, 2023 15:59

mayeul-zama force-pushed the mz/docs/improve branch from bdb1467 to 72c634a Compare September 11, 2023 16:02

mayeul-zama requested a review from tmontaigu September 12, 2023 08:48

mayeul-zama unassigned tmontaigu Sep 12, 2023

mayeul-zama force-pushed the mz/docs/improve branch from 72c634a to 214cacd Compare September 12, 2023 12:00

mayeul-zama force-pushed the mz/docs/improve branch from 214cacd to 622287c Compare September 13, 2023 08:23

mayeul-zama requested a review from IceTDrinker September 13, 2023 08:23

mayeul-zama force-pushed the mz/docs/improve branch from 622287c to 247147e Compare September 13, 2023 12:26

tmontaigu reviewed Sep 13, 2023

View reviewed changes

IceTDrinker reviewed Sep 14, 2023

View reviewed changes

mayeul-zama added 4 commits September 14, 2023 17:33

chore(docs): doc fixes and improvements

5294332

chore(docs): refactor dark market

a2ec29e

chore(docs): remove fallible directory change

b1abd7a

chore(docs): simplify improved formula in dark market

065d415

mayeul-zama force-pushed the mz/docs/improve branch from a0fb04b to 065d415 Compare September 14, 2023 15:35

mayeul-zama requested review from IceTDrinker and tmontaigu September 14, 2023 16:09

tmontaigu approved these changes Sep 15, 2023

View reviewed changes

github-actions bot added the approved label Sep 15, 2023

mayeul-zama merged commit b553a68 into main Sep 18, 2023
30 checks passed

mayeul-zama deleted the mz/docs/improve branch September 18, 2023 07:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix/improve docs #540

fix/improve docs #540

mayeul-zama commented Sep 11, 2023

github-actions bot commented Sep 11, 2023

IceTDrinker Sep 11, 2023

mayeul-zama Sep 11, 2023

IceTDrinker Sep 13, 2023

mayeul-zama Sep 13, 2023 •

edited

Loading

github-actions bot commented Sep 11, 2023

github-actions bot commented Sep 11, 2023

github-actions bot commented Sep 12, 2023

github-actions bot commented Sep 13, 2023

codecov bot commented Sep 13, 2023 •

edited

Loading

github-actions bot commented Sep 13, 2023

tmontaigu Sep 13, 2023

mayeul-zama Sep 14, 2023

github-actions bot commented Sep 13, 2023

IceTDrinker Sep 13, 2023

mayeul-zama Sep 14, 2023

github-actions bot commented Sep 14, 2023

github-actions bot commented Sep 15, 2023

IceTDrinker commented Sep 18, 2023

mayeul-zama commented Sep 18, 2023

		@@ -3,6 +3,7 @@ TFHE-rs includes features to reduce the size of both keys and ciphertexts, by co

		In the library, entities that can be compressed are prefixed by `Compressed`. For instance, the type of a compressed `FheUint256` is `CompressedFheUint256`.

		In the following example code, we use the `bincode` crate dependency to compare serialized sizes.


		* The input string can only contain ascii characters.

		It is not possible to create branches where the condition if an encrypted integer, meaning the function cannot use conditional statements.

fix/improve docs #540

fix/improve docs #540

Conversation

mayeul-zama commented Sep 11, 2023

github-actions bot commented Sep 11, 2023

IceTDrinker Sep 11, 2023

Choose a reason for hiding this comment

mayeul-zama Sep 11, 2023

Choose a reason for hiding this comment

IceTDrinker Sep 13, 2023

Choose a reason for hiding this comment

mayeul-zama Sep 13, 2023 • edited Loading

Choose a reason for hiding this comment

github-actions bot commented Sep 11, 2023

github-actions bot commented Sep 11, 2023

github-actions bot commented Sep 12, 2023

github-actions bot commented Sep 13, 2023

codecov bot commented Sep 13, 2023 • edited Loading

Codecov Report

github-actions bot commented Sep 13, 2023

tmontaigu Sep 13, 2023

Choose a reason for hiding this comment

mayeul-zama Sep 14, 2023

Choose a reason for hiding this comment

github-actions bot commented Sep 13, 2023

IceTDrinker Sep 13, 2023

Choose a reason for hiding this comment

mayeul-zama Sep 14, 2023

Choose a reason for hiding this comment

github-actions bot commented Sep 14, 2023

github-actions bot commented Sep 15, 2023

IceTDrinker commented Sep 18, 2023

mayeul-zama commented Sep 18, 2023

mayeul-zama Sep 13, 2023 •

edited

Loading

codecov bot commented Sep 13, 2023 •

edited

Loading