-
Notifications
You must be signed in to change notification settings - Fork 155
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore(docs): add strings guides #1922
base: main
Are you sure you want to change the base?
Conversation
7c4ebbb
to
79523f9
Compare
tfhe/docs/guides/strings.md
Outdated
This document explains the string type provided by the High-level API. | ||
|
||
TFHE-RS has supports for **ASCII** strings with the type `FheAsciiString`. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
TFHE-rs maybe even **TFHE-rs**
add a warning about missing Compact/Compressed
Talk about the fact it was a bounty that was integrated @yuxizama if you have a wording to advertise the bounty program
3005732
to
91b6ea3
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Small things, let's not merge right away once it's ready we are supposed to share documentation for review by marketing product first
tfhe/docs/guides/strings.md
Outdated
{% endhint %} | ||
|
||
{% hint style="warning" %} | ||
Strings are not yet compatible with CompactCiphertextList and CompressedCiphertextList |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe use ` as well to surround the type names here
A lot of common operations are supported, to list a few of them: | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if the op names are the same between HL traits and the strings module let's think of linking to docs.rs
which makes me think we should update the Cargo.toml for the docs.rs build to also use the strings feature, seems we don't build strings on docs.rs at the moment
tfhe/docs/guides/strings.md
Outdated
let mut buffer2 = vec![]; | ||
safe_serialize(&other_string, &mut buffer2, 1 << 30).unwrap(); | ||
// The two strings created with padding, have the same | ||
// memory/disk footprint, even though |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
even though ?
91b6ea3
to
561e1c3
Compare
No description provided.