facebookresearch/FLSim

Please provide documentation

Opened this issue · 1 comments

❓ Questions and Help

Until we move the questions to another medium, feel free to use this to submit your question:

Question

Hi, please could you share any form of documentation? The library itself is very large and features a number of methods, functions and ways to define the same thing using different data structures. There currently is 0 documentation except for a number of in-code comments. Particularly the issue becomes worse when dealing with config files, as there is no way of figuring out of what an expected structure is supposed to look like.

I'm sorry for the lack of documentation :/
I'll flag this to our team