Skip to content

including ModelBuilder intro notebook #565

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

Merged
merged 6 commits into from
Sep 5, 2023

Conversation

michaelraczycki
Copy link
Contributor

@michaelraczycki michaelraczycki commented Aug 3, 2023

This PR includes the introduction of new module of PyMC-experimental, ModelBuilder.


📚 Documentation preview 📚: https://pymc-examples--565.org.readthedocs.build/en/565/

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@drbenvincent
Copy link
Contributor

Hi @michaelraczycki. Looks like this could be pretty cool. Before diving in to a proper review, a few changes are needed:

  • I'd pick a simpler name for the notebook, ideally no spaces. This will be useful if/when it comes to using sphinx to reference between notebooks in the docs.
  • Placing the notebook inside a new folder model_builder will create a new section in the docs. I don't think we need a complete section on the module builder. Instead, I'd recommend putting it in the howto folder/section.
  • Notebooks for pymc-examples have a reasonably hefty set of formatting and style requirements. There's a very useful guide here https://www.pymc.io/projects/docs/en/latest/contributing/jupyter_style.html which in turn has links to a video and a template notebook.

Just give me a shout when it's ready for re-review.

@michaelraczycki
Copy link
Contributor Author

@drbenvincent I think that all the formatting should be there now

@twiecki
Copy link
Member

twiecki commented Aug 18, 2023

I don't think we should add the same NB from pymc-marketing here. Instead, we should update https://github.com/pymc-devs/pymc-examples/blob/main/examples/howto/model_builder.ipynb to the latest API.

@twiecki
Copy link
Member

twiecki commented Aug 31, 2023

@michaelraczycki There's 2 NBs here, is that on purpose? Also, the pre-commit should generate a myst file that should be included here too.

@michaelraczycki
Copy link
Contributor Author

you're right, for some reason the deletion of the model_builder folder and it's notebook didn't get committed. It's fixed now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants