Add Example Gallery

[juanitorduz]

Add an example gallery to harmonize the example layout in PyMC and Pytensor. I followed pymc-devs/pytensor#1150 from @jessegrabowski (thank you!) and some help from Sonnet ;)

I also added some subsections for the MMM docs to make it easy to access the material.

This is a snapshot:

---

📚 Documentation preview 📚: https://pymc-marketing--1611.org.readthedocs.build/en/1611/

[williambdean]

Are thumbnails required? What happens if one isnt included?

[twiecki]

This is great! Is there no NB on geo?

[juanitorduz]

This is great! Is there no NB on geo?

There is! MMM Multidimensional Example Notebook :)

[twiecki]

Should we give that a better name?

[williambdean]

This looks awesome. Do you know if "Section Navigation" on the left side can be removed. It is currently empty

[williambdean]

Show we give that a better name?

Specifically Geo MMM Example? What do you have in mind?

[juanitorduz]

The dependency issue is independent of this PR, it seems as other builds are failing https://app.readthedocs.org/projects/pymc-marketing/builds/27719823/

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.53%. Comparing base (5e92892) to head (15da2c4).
Report is 84 commits behind head on main.

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1611   +/-   ##
=======================================
  Coverage   93.53%   93.53%           
=======================================
  Files          55       55           
  Lines        6357     6357           
=======================================
  Hits         5946     5946           
  Misses        411      411           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[williambdean]

The "How-to" is now pushed into the "More" dropdown menu. At least with my screen size. Maybe we can link at the top of the Gallery section. Or specify that these are all the same notebooks, just different way to organize them

[williambdean]

Think this looks great.

What is the process for adding a new notebook now? Can we outline that and raise if we can detect?

[juanitorduz]

What is the process for adding a new notebook now? Can we outline that and raise if we can detect?

I think the workflow is very similar as before: add the notebook into the notebooks folder and add it in gallery.md (instead of howto.md)

[jessegrabowski]

I think the workflow is very similar as before: add the notebook into the notebooks folder and add it in gallery.md (instead of howto.md)

You didn't like the auto-generated gallery the other script did?

[juanitorduz]

Oh! I need to double-check! I kind of wanted to have the freedom to define the gallery structure but ill revise it 👀

[juanitorduz]

I will tackle this in a following PR, see the issue #1617 . The current notebook list is just very ugly, so let's work on iterations 🙏

[twiecki]

Show we give that a better name?

Specifically Geo MMM Example? What do you have in mind?

Anything that makes someone that is looking for Geo MMM click on that NB. I just think multi-dimensional is not that. Whether that's a rename or new NB with that name.

[twiecki]

Is howto superseded by this? In that case I think we should consider just removing it.

[williambdean]

Is howto superseded by this? In that case I think we should consider just removing it.

Would the previous links still work? Would that break any references in social posts?

[juanitorduz]

Is howto superseded by this? In that case I think we should consider just removing it.

It is now removed

[juanitorduz]

Is howto superseded by this? In that case I think we should consider just removing it.

Would the previous links still work? Would that break any references in social posts?

I think so, still, I had gotten feedback that it was not clear for many people that "howto" contained the example notetbooks.

[juanitorduz]

@twiecki I added some info regarding geo-mmm

It is not the main title, as many users are using other types of dimensions (e.g., outlets)

[juanitorduz]

@williambdean can we merge this one? 🙏

[williambdean]

@williambdean can we merge this one? 🙏

Let's do it!