search

dmey / synthia

📈 🐍 Multidimensional synthetic data generation with Copula and fPCA models in Python
https://dmey.github.io/synthia
MIT License
53 stars 9 forks source link

Review: Clarify API #25

Closed mnarayan closed 3 years ago

mnarayan commented 3 years ago

It would be helpful to add/explain what the different classes do Data Generators, Parametrizer, Transformers somewhere in the introduction or usage component of the documentation. Explain the different classes and what each is supposed to do. If it is similar to or inspired by well-known API of a different package, please point to it.

I think generators and transformers are obvious but I only sort of understand Parametrizers. It is also confusing in the sense that people might think this has something to do with parametric distributions when you mean it to be something different.

Is this API for Parametrizers inspired by some convention elsewhere? If so it would be helpful to point to that. For instance, the generators are very similar to statsmodel generators.

dmey commented 3 years ago

Thanks for the feedback -- I have updated the API as per you comments. Can you please check https://dmey.github.io/synthia/api.html and let me know if the sections are clearer?

mnarayan commented 3 years ago

LGTM