pymc-devs / pymc

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

DOC: Summarize best practices #7096

Open cluhmann opened 9 months ago

cluhmann commented 9 months ago

Idea or request for content:

I think it would be good to have a set of best practices and/or practices that are "intuitive" but not ideal. The sorts of things I am thinking about might include:

and probably many others.

I think the one question is where content like this would live in order to be visible by users. There's nothing else like it in the example gallery. The source of https://www.pymc.io would probably fit, but I'm not sure how much traffic ends up going there. It wouldn't make much sense to write all this up but then not having anyone read it.

OriolAbril commented 8 months ago

Part of that is already covered in https://www.pymc.io/projects/docs/en/latest/contributing/jupyter_style.html#variable-names (and dropdown section). But I agree it would make sense to promote to its own page and extend. It would be a great resource even if only for guidance in writing example notebooks.