-
-
Notifications
You must be signed in to change notification settings - Fork 2k
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
Review and update API docs #5282
Comments
#5367 updated import paths and reviewed everything was present for the gp module. Model, sampling, step functions, backends, logprob, bart, smc, vi... are still missing |
From #5308 (comment). Only the |
Noticed in #5543 that pymc.draw passes the kwargs to |
We can also look into improving the structure, grouping the functions in the math page by type, logical, matrix operations, trigonometric... grouping distributions inside discrete or continuous also in different groups depending on the range for example of their domain, grouping related functions that are in different files (i.e. set_data is in model.py, like Potential or Deterministic and are now in model section, but they could be divided between the data and distribution sections)... |
All the |
Let's punt this to 4.1. |
In a recent discourse post it was mentioned that the kwargs available for all distributions are not documented. I could only find them in the docstring of the undocumented |
We need to make sure all our public api is documented and that they are documented at the recommended import path. #5266 updated the distributions subsection (but I did not check there were no distributions missing) and can be used as template.
Note: if there are functions/classes that are not (or should not be) part of the public api but you think it would be helpful (even if only to you) to have a rendered version of their docstring on the website list them here too. I am considering adding a private api subsection within the contributing section
The text was updated successfully, but these errors were encountered: