Skip to content

Add high-level documentation for PIR parameters #43

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.

Sign up for GitHub

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

Jump to bottom
Open
kshehata opened this issue Aug 21, 2020 · 0 comments
Open

Add high-level documentation for PIR parameters #43

kshehata opened this issue Aug 21, 2020 · 0 comments
Labels
Type: Documentation 📚 Improvements or additions in documentation for some file, feature, or codebase

Comments

@kshehata
Copy link
Contributor

Where?

Should probably be in the top level readme file

Who?

Users of the library

What?

Top level PIR parameters and important encryption parameters, like database sizing, poly_mod_degree, plain mod bit size, etc. Should include what they do and how to chose them.

Additional Context

Need to include some info about SEAL, but should probably point to their documentation instead of reproducing it.
@kshehata kshehata added the Type: Documentation 📚 Improvements or additions in documentation for some file, feature, or codebase label Aug 21, 2020
@kshehata kshehata mentioned this issue Aug 21, 2020
Merged
4 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Type: Documentation 📚 Improvements or additions in documentation for some file, feature, or codebase
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@kshehata