search

pymc-devs / pymc

Bayesian Modeling and Probabilistic Programming in Python
https://docs.pymc.io/
Other
8.71k stars 2.01k forks source link

Feature Request: Link API docs to PyMC-Examples that use the classes/methods #6542

Open ricardoV94 opened 1 year ago

ricardoV94 commented 1 year ago

Description

I don't know if this can be automated in any way, but it would be nice that when you go to https://www.pymc.io/projects/docs/en/stable/api/distributions/generated/pymc.Censored.html, it would show links to relevant notebooks like https://www.pymc.io/projects/examples/en/latest/generalized_linear_models/GLM-truncated-censored-regression.html

Or the relevant tag? https://www.pymc.io/projects/examples/en/latest/blog/tag/censored.html

OriolAbril commented 1 year ago

There already is a proof of concept for this: https://www.pymc.io/projects/examples/en/latest/object_index/index.html. We need to list things manually the first time like it happens with our api docs, but the listing of actual examples is completely automated, see for example: https://www.pymc.io/projects/examples/en/latest/object_index/distributions/continuous.html. We would only need to link from api docs to the right section (might be even possible to automate)

I don't think it makes sense to work too much on this until we have closed #5282 though, as many of the sections are quite strange (in addition to the missing things). After that it would be only a matter of copying the reviewed hierarchy over.

We could start with distributions already for example as that section probably won't change much? And it is one of the main things people will want to see