Skip to content

Review potentially outdated docs #5538

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

Closed
4 tasks done
OriolAbril opened this issue Mar 3, 2022 · 8 comments · Fixed by #6693
Closed
4 tasks done

Review potentially outdated docs #5538

OriolAbril opened this issue Mar 3, 2022 · 8 comments · Fixed by #6693
Assignees

Comments

@OriolAbril
Copy link
Member

OriolAbril commented Mar 3, 2022

There are some files closely related to v3 internals that should be reviewed to choose if we want to update and keep them or get rid of them (and maybe write something similar but not the same from scratch).

Those files are:

@OriolAbril OriolAbril added this to the v4.0.0 milestone Mar 3, 2022
@ricardoV94 ricardoV94 self-assigned this Mar 16, 2022
@juanitorduz
Copy link
Contributor

Hi! @ricardoV94 has some very useful notes which I could build on top of. I will open a PR soon.

@ricardoV94
Copy link
Member

ricardoV94 commented Apr 20, 2022

Advanced_usage_of_Aesara_in_PyMC.rst

I think we can remove it.

  1. It mentions shared variables, which are wrapped in the more user friendly pm.MutableData,
  2. It shows the creation of an Op, which we have some examples of in pymc-examples. The one advantage of that Op example is that unlike those in pymc-examples it is an intermediate Op and not just a likelihood term, which might bridge a gap in the documentation. In any case a separate issue for a doc or pymc-examples should be made for that

Tracking issue #5729

PyMC_And_Aesara.rst

This one is not in a terrible state, but should be expanded beyond describing how variables are used for the logp graph, to also explain how RandomVariables are used for the random graph, and how PyMC goes back and forth between those. That's probably where @juanitorduz would be contributing

Shoud be replaced by #5721

Probability_Distributions.rst

We can replace this entirely by the new dev guide on how to develop new distributions and by updating this pymc-example: pymc-devs/pymc-examples#185

Gaussian_Processes.rst

Not my expertise, perhaps @bwengals can chime in.

Tracking issue #5720

@juanitorduz
Copy link
Contributor

I do have a working branch and notebook where I am trying to add comments and understand @ricardoV94 nice intro notebook. Nevertheless, I still have a long way to fully understand. Specifically, starting from section Graph manipulation 102 things become less clear for me. I would live to work on this one but to be honest it would take much more than initially planned. Hence, if there is some desire to have it soon (in view of the next release) maybe some else could jump in as well :)

@ricardoV94
Copy link
Member

ricardoV94 commented Apr 20, 2022

@juanitorduz no need to include any graph manipulation parts. You can also just open a PR with what you have and iterate from there :)

@canyon289
Copy link
Member

canyon289 commented Apr 20, 2022

Gaussian_Processes.rst will be updated by a combination of myself and @bwengals over the coming months. if it helps with tracking I can open an issue and assign it to myself.

For now I can add a disclaimer at the top stating its V3 specific and slated for an update

@AlexAndorra
Copy link
Contributor

Done: #5826

@twiecki twiecki modified the milestones: v4.0.0, v4.1.0 Jun 3, 2022
@michaelosthege michaelosthege modified the milestones: v4.1.0, v4.2.0 Jul 2, 2022
@ricardoV94 ricardoV94 modified the milestones: v4.2.0, v4.3.0 Sep 14, 2022
@ricardoV94 ricardoV94 modified the milestones: v4.3.0, v4.4.0 Oct 27, 2022
@OriolAbril
Copy link
Member Author

No, sounds good

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

Successfully merging a pull request may close this issue.

7 participants