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

Better documentation of save and load methods #834

Open
wd60622 opened this issue Jul 14, 2024 · 1 comment
Open

Better documentation of save and load methods #834

wd60622 opened this issue Jul 14, 2024 · 1 comment
Labels
docs Improvements or additions to documentation ModelBuilder Related to the ModelBuilder class and its children

Comments

@wd60622
Copy link
Contributor

wd60622 commented Jul 14, 2024

What are the requirement of the inference data/ attrs? What methods are required from child classes?

Currently seems like the process is save and load a single InferenceData object. Apart from the usual prior, posterior, etc, this object will have:

  • fit_data group which will contain the data used for fitting the model
  • attrs attribute which has all the required information to reconstructure the initial model. This only has the restriction of being JSON serializable.

However, in this process, there seems to be much writing in order to load a model as the attrs need to be parsed and the class needs to be reconstructed. Aside from just loading, the model needs to be built.

@wd60622 wd60622 added docs Improvements or additions to documentation ModelBuilder Related to the ModelBuilder class and its children labels Jul 14, 2024
@wd60622 wd60622 changed the title Better document save and load Better documentation of save and load methods Jul 14, 2024
@wd60622
Copy link
Contributor Author

wd60622 commented Jul 30, 2024

There is a bit of information in the deployment section here:
https://www.pymc-marketing.io/en/latest/guide/benefits/model_deployment.html

Think the documentation for the ModelBuilder itself could be spruced up

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 ModelBuilder Related to the ModelBuilder class and its children
Projects
None yet
Development

No branches or pull requests

1 participant