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

Update glm robust with outliers and add extra dependency template #249

Merged
merged 14 commits into from
Dec 10, 2021

Conversation

OriolAbril
Copy link
Member

@OriolAbril OriolAbril commented Nov 17, 2021

I started with a couple build warnings, then moved to fixing a couple lines in the notebook as it was
generating warnings due to consecutive horizontal lines and other formatting nits, and
ended up rerunning the notebook, updating all plotting and generating a template proposal for
extra dependencies in notebooks. The dependencies template is related to #200

@review-notebook-app
Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@OriolAbril
Copy link
Member Author

Here is the preview (@jonsedar might be interested? I realized there were some mistakes with ArviZ usage in the latest update, that I actually reviewed but not too well, everything is fixed now I believe), and the specific link to the extra installs section (the attention and dropdown are the template.

I have added:

:::{include} extra_installs.md
:::

in a markdown cell plus a notebook metadata key that says "extra_dependencies: seaborn" and all the commands and text are imported from the template. cc @martinacantaro @chiral-carbon @Sayam753

@jonsedar
Copy link

Can it really be six years? Looks pretty good, I really like the book styling - what is that?

I've an action unfortunately very far down my todo list to create more...

@OriolAbril
Copy link
Member Author

I really like the book styling - what is that?

What part of the styling do you mean? I think the only common point between how notebooks were built around the beginning of this year and now is that we still use sphinx.

  • We changed the theme. It is no longer a pymc specific theme but the https://pydata-sphinx-theme.readthedocs.io/en/latest/, used also in several other projects. This ensures the theme will continue to look good and work without us intervening, unlike before where issues with the theme like the search bar not working were on us and took a long time to fix if they were fixed at all.
  • We changed the notebook rendering engine from nbsphinx to myst-nb. This allows us to take advantage of all sphinx features and extensions also within the notebooks. We can then for example use sphinxcontrib-bibtex to cite like in latex and generate auto intext citations with customizable format and automatic bibliography sections.
  • We have integrated several extra extensions with the build. Most notably ablog which handles tags and categories with notebooks to improve navigation and notebook finding. But also sphinx-design for cool formatting options like dropdows or tabs to compare alternatives, bibtex support as mentioned, or sphinx-codeautolink in order to autoupdate some objects in the code blocks to hyperlinks to their documentation.
  • We also added extra custom templates to extend the theme like the recommended citation at the bottom (mostly automatic) or the github/binder/colab badges (completely automatic).

CONTRIBUTING.md Outdated Show resolved Hide resolved
examples/generalized_linear_models/GLM-robust.ipynb Outdated Show resolved Hide resolved
@OriolAbril OriolAbril merged commit 20dcbdb into main Dec 10, 2021
@OriolAbril OriolAbril deleted the minor_tweaks branch December 10, 2021 03:17
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