openfheorg / openfhe-python

Official Python wrapper for OpenFHE. Current release is v0.8.9 (released on September 10, 2024).
https://openfheorg.github.io/openfhe-python/html/index.html
BSD 2-Clause "Simplified" License
73 stars 21 forks source link

Missing documentation for parameters? #97

Closed yav closed 3 months ago

yav commented 8 months ago

I can't seem to find any documentation in here https://openfheorg.github.io/openfhe-python/html/cryptocontext.html, about the parameter creation functions CCParamsBFVRNS and friends. The source code is easy enough to follow so not a blocker, but it'd be nice to add them to the docs.

arcturusannamalai commented 5 months ago

Seems like we need to introduce parametrized docs for the code

template <typename T>
void bind_parameters(py::module &m,const std::string name)

in file

openfhe-python/src/lib/bindings.cpp
arcturusannamalai commented 5 months ago

actually the solution seems simple to just add whats already available without adding more doc

Screenshot 2024-04-28 at 2 42 04 PM
arcturusannamalai commented 4 months ago

updated PR @yspolyakov - https://github.com/openfheorg/openfhe-python/pull/143