Docs: revamp MMM modeling docs and references#2453
Draft
cetagostini wants to merge 1 commit into
Draft
Conversation
Rename skill to `pymc-marketing-mmm` and modernize MMM docs and examples. Switch examples to the multidimensional MMM import, remove deprecated nuts_sampler usage, and update YAML builder call (config_path). Add comprehensive documentation for adstock and saturation transforms, priors best-practices (prefer priors on transformation objects), prior-predictive checks, original-scale contribution variables, event effects, CPT (cost-per-target) calibration (observed Normal likelihood) and geo-level CPT examples, and improved guidance for time-varying parameters (HSGP options). Clarify reserved dimension names and introduce new constructor params (cost_per_unit, dag, treatment_nodes, outcome_node). Update plotting, CV, and budget-optimization examples (new params and return shapes), adjust convenience data/api method names, and refine various doc links and examples across references/liftest_calibration.md and references/model_specification.md to reflect API changes and best practices.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Rename skill to
pymc-marketing-mmmand modernize MMM docs and examples. Switch examples to the multidimensional MMM import, remove deprecated nuts_sampler usage, and update YAML builder call (config_path).Add comprehensive documentation for adstock and saturation transforms, priors best-practices (prefer priors on transformation objects), prior-predictive checks, original-scale contribution variables, event effects, CPT (cost-per-target) calibration (observed Normal likelihood) and geo-level CPT examples, and improved guidance for time-varying parameters (HSGP options). Clarify reserved dimension names and introduce new constructor params (cost_per_unit, dag, treatment_nodes, outcome_node).
Update plotting, CV, and budget-optimization examples (new params and return shapes), adjust convenience data/api method names, and refine various doc links and examples across references/liftest_calibration.md and references/model_specification.md to reflect API changes and best practices.
Description
Related Issue
Checklist
pre-commit.ci autofixto auto-fix.📚 Documentation preview 📚: https://pymc-marketing--2453.org.readthedocs.build/en/2453/