-
-
Notifications
You must be signed in to change notification settings - Fork 2.1k
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
Add docstring and type hints to DistributionMeta #5353
Comments
With some googling I'm realizing that clsdict seems to be some convention for ABCMeta functionality. Nonetheless I think we should still document it in PyMC for these following reasons
The subset of people in the world that have enough stats knowledge to contribute to PyMC, know Python well enough to know what each individual line does, and know the design patterns of PyMC, AePPL, and Aesara is very small. I'm definitely not one of them :) Documentation will go a long way to help make this critical part of the library less challenging to understand! https://programtalk.com/python-examples/abc.ABCMeta.__init__/ |
See #5308 |
It looks like this was addressed already. Can it be closed? |
Description of your problem
Please add more documentation to
DistributionMeta
. This code block controls the logic for basically all distributions but its unclear what exactly its doing, or why.For example whats cls_dict, how is it created, why is it needed?
https://github.com/pymc-devs/pymc/blob/main/pymc/distributions/distribution.py#L76
Note: This not a beginner issue, one of the core devs should do it to ensure its fully descriptive and contains all nuances
The text was updated successfully, but these errors were encountered: