Skip to content
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

Documentation needed for model_config #1179

Open
cluhmann opened this issue Nov 6, 2024 · 2 comments
Open

Documentation needed for model_config #1179

cluhmann opened this issue Nov 6, 2024 · 2 comments
Labels
docs Improvements or additions to documentation model config

Comments

@cluhmann
Copy link
Contributor

cluhmann commented Nov 6, 2024

For both MMM and CLV, the model constructors take a config dict called model_config. I can find examples this dict in various notebooks, but I cannot find any specification about what keys/values are valid/invalid. Searching for "model_config" in the docs returns the model_config class, which contains nothing but parse_model_config which provides more examples (and a rather unhelpful invalid example) , but no specification. Is this documented anywhere? If so, it should be pointed to in the documentation more thoroughly. If not, it should be documented.

I also see that there are other (potentially nested) config dicts like intercept_tvp_config. Are the specifications of those documented anywhere?

@cluhmann cluhmann added the docs Improvements or additions to documentation label Nov 6, 2024
@wd60622
Copy link
Contributor

wd60622 commented Nov 6, 2024

@cluhmann
Copy link
Contributor Author

cluhmann commented Nov 6, 2024

I guess that is some additional info. But where does one figure out that keys such as "alpha" and "beta" are valid? Or keys like "intercept", "saturation_beta", "saturation_lam", and "likelihood"? And/or when are such key valid and when are they invalid? Are they model-dependent? Are they tied to choices about the adstock and/or saturation functions?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation model config
Projects
None yet
Development

No branches or pull requests

2 participants