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

Add example gallery to docs #1150

Merged
merged 21 commits into from
Jan 13, 2025

Conversation

jessegrabowski
Copy link
Member

@jessegrabowski jessegrabowski commented Jan 8, 2025

Description

This PR adds an example gallery to the Pytensor docs (like PyMC-Examples). Right now it's a bit hidden, but it's more a proof of concept than anything else. We can start populating it with short vignettes on how to use pytensor, and maybe some longer worked examples of what you can do with the library.

There's a dumb example notebook in there now, but that should be replaced with some real stuff before this is merged.

Related Issue

Checklist

Type of change

  • New feature / enhancement
  • Bug fix
  • Documentation
  • Maintenance
  • Other (please specify):

Copy link

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@ricardoV94
Copy link
Member

The footer still says "Citing PyMC examples"

@ricardoV94
Copy link
Member

Looks good to me. I have some ideas on the Scan example but I would do it after we merge this PR

@jessegrabowski
Copy link
Member Author

We don't need to merge these notebooks. Obviously the intro to pytensor one should be deleted. I just wanted stuff in there to check that things were working, and I remembered @cluhmann 's comment that "the best source for scan isn't even in our docs".

@ricardoV94
Copy link
Member

ricardoV94 commented Jan 11, 2025

We can remove the intro (or bring from the docs). Not too worried about merging these examples as is

@jessegrabowski
Copy link
Member Author

jessegrabowski commented Jan 11, 2025

I was also thinking about porting the tutorial series into the gallery. They will be much easier to maintain as notebooks, and should have a lot more visibility.

But we should have an into notebook that answers the question "what is this package and why should I use it"

Delete placeholder notebook
@jessegrabowski jessegrabowski marked this pull request as ready for review January 11, 2025 09:56
@jessegrabowski
Copy link
Member Author

I also need to add inter-package links to the two remaining notebooks. I was also thinking we should either put some plots in the notebooks or generate images, so the thumbnails aren't both just the rocket logo

@ricardoV94
Copy link
Member

I was also thinking about porting the tutorial series into the gallery. They will be much easier to maintain as notebooks, and should have a lot more visibility.

Yeah

But we should have an into notebook that answers the question "what is this package and why should I use it"

Not sure it's better has a notebook but I'm doing something like that

@jessegrabowski
Copy link
Member Author

Gonna stop tinkering on this one and call it done. I am starting to look at fixing other issues in the docs that are unrelated to the gallery, but those should be separate issues.

The only super out-of-scope thing I did here was to add a robots.txt and a sitemap.xml that should improve our indexing. I can drop that commit if we want someone with more web experience to look at it first.

@ricardoV94
Copy link
Member

The failing tests are due to new scipy, I have a fix in another PR

@jessegrabowski jessegrabowski merged commit 2b57f74 into pymc-devs:main Jan 13, 2025
54 of 60 checks passed
@jessegrabowski jessegrabowski deleted the example-gallery branch January 13, 2025 00:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants