pymc icon indicating copy to clipboard operation
pymc copied to clipboard

Add README example to docs

Open Krupakar-Reddy-S opened this issue 1 year ago • 11 comments

Description

Added the example from pymc REAME.md to the pymc_overview notebook in learn section of docs as case study 0.

Related Issue

  • [x] Closes #7411
  • [x] Related to #7411

Checklist

Type of change

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

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

Krupakar-Reddy-S avatar Aug 05 '24 14:08 Krupakar-Reddy-S

Thank You Banner] :sparkling_heart: Thanks for opening this pull request! :sparkling_heart: The PyMC community really appreciates your time and effort to contribute to the project. Please make sure you have read our Contributing Guidelines and filled in our pull request template to the best of your ability.

welcome[bot] avatar Aug 05 '24 14:08 welcome[bot]

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

image

After updating there are empty bars before output tables, these correspond to weird Output () in the notebook rendered in github.

image

please advice on how to fix this :)

Krupakar-Reddy-S avatar Aug 06 '24 01:08 Krupakar-Reddy-S

Hm, now looking at this, I'm not sure what this example provides in addition to example 1 (sorry)... @OriolAbril what are your thoughts here?

twiecki avatar Aug 06 '24 10:08 twiecki

Another idea would be to put that example on the welcome page: https://www.pymc.io/welcome.html

twiecki avatar Aug 06 '24 10:08 twiecki

Hm, now looking at this, I'm not sure what this example provides in addition to example 1 (sorry)... @OriolAbril what are your thoughts here?

I felt the same as there was a very detailed motivating example before this. ok then i will put it up on the welcome page.

Krupakar-Reddy-S avatar Aug 06 '24 11:08 Krupakar-Reddy-S

While we're here, do you want to change the imports at to pt (pytensor)?

twiecki avatar Aug 06 '24 11:08 twiecki

While we're here, do you want to change the imports at to pt (pytensor)?

Sure :) Also what version of pymc to use here, i have used 5.15.1 for my previous changes or is there a specific standard for the docs notebooks?

Krupakar-Reddy-S avatar Aug 06 '24 12:08 Krupakar-Reddy-S

The most recent one ideally but it doesn't matter too much here.

twiecki avatar Aug 06 '24 20:08 twiecki

I have raised the PR here to add the example to the welcome page. I will raise for the import name change here :)

Krupakar-Reddy-S avatar Aug 07 '24 10:08 Krupakar-Reddy-S

Thanks for your patience :).

twiecki avatar Aug 08 '24 10:08 twiecki