search

pymc-labs / pymc-marketing

Bayesian marketing toolbox in PyMC. Media Mix (MMM), customer lifetime value (CLV), buy-till-you-die (BTYD) models and more.
https://www.pymc-marketing.io/
Apache License 2.0
577 stars 135 forks source link

Automate UML image generation #211

Open drbenvincent opened 1 year ago

drbenvincent commented 1 year ago

210 added UML diagrams to the CONTRIBUTING.md file.

At the moment these are manually generated, e.g.

pyreverse pymc_marketing/mmm -d docs/source/uml -f 'ALL' -o png -p mmm
pyreverse pymc_marketing/clv -d docs/source/uml -f 'ALL' -o png -p clv

I initially tried to automate this by placing these lines into the makefile, but that caused the remote build of the docs to fail.

We need to automate the generation of the latest UML diagrams. One idea would be to have this happen locally as a pre-commit check.

wd60622 commented 1 month ago

Is this still of interest? I'm guessing that the current diagram is very stale!

drbenvincent commented 1 month ago

Is this still of interest? I'm guessing that the current diagram is very stale!

I think we might be up to date, but not 100% sure on that. But it would be cool to automate it, yes. Not sure what the best trigger should be - if it's deterministic then I guess it doesn't matter if it's run much more frequently than it needs to be.

EDIT: Sorry I thought this was a comment on the CausalPy repo - I'm using the GitHub app on my phone. It probably is out of date. If you implement here, could you also do it for CausalPy?