Skip to content

Update Gaussian_Processes.rst for v5 #5720

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
canyon289 opened this issue Apr 20, 2022 · 5 comments · Fixed by #6693
Closed

Update Gaussian_Processes.rst for v5 #5720

canyon289 opened this issue Apr 20, 2022 · 5 comments · Fixed by #6693
Assignees
Labels
docs GP Gaussian Process

Comments

@canyon289
Copy link
Member

canyon289 commented Apr 20, 2022

Description of your problem

As title reads update the docs. Bill and I are on it and will get it done sometime by July. Creating this issue to track

#5538
https://github.com/pymc-devs/pymc/blob/main/docs/source/guides/Gaussian_Processes.rst

@canyon289 canyon289 self-assigned this Apr 20, 2022
@ricardoV94 ricardoV94 added docs GP Gaussian Process labels Apr 27, 2022
@OriolAbril
Copy link
Member

Whenever we get to update this page, we have to make sure to add a target additive_gp at the section on additive GPs.


With myst, targets are added with:

(additive_gp)=
## Section heading

with rst it is instead:

.. _additive_gp:

Section heading
---------------

(the underscore is important and part of the syntax, not of the target)

@daniel-saunders-phil
Copy link
Contributor

Hi all, I would be interested in picking this up. It would be helpful to get some sense of what needed changes have already been identified. I imagine the main one is just executing the code and making small adjustments to ensure compatibility with version 5. But any other concerns come to mind?

@daniel-saunders-phil
Copy link
Contributor

It looks like the change from pymc3 to 4/5 didn't introduce any problems that require the code to adjust. The core functionality of the gp module has stayed pretty consistent across version. The only change I noticed was that noise is now called sigma. I also spotted and fixed a broken link. Otherwise, I'm not sure what else needs to be done. The content is still very helpful and fills an important gap between the GP examples and the GP documentation.

@OriolAbril
Copy link
Member

Are there code examples that can be executed? If so I'd update the content to jupyter or myst notebook (example of myst notebook in case it helps, it is a raw text notebook format) and move it to the core notebooks folder.

If the code snippets there should not be executed, keep it as rst but move it to the core notebooks folder too.

After that, add it to the toctree in https://github.com/pymc-devs/pymc/blob/main/docs/source/learn/core_notebooks/index.md and it will appear again on the docs

@daniel-saunders-phil
Copy link
Contributor

Looks like the code was originally designed to be more schematic and wasn't intended to be executed. I submitted a PR to move the .rst file and also added it to the toctree.

@OriolAbril OriolAbril linked a pull request May 15, 2023 that will close this issue
@OriolAbril OriolAbril changed the title Update Gaussian_Processes.rst for v4 Update Gaussian_Processes.rst for v5 May 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs GP Gaussian Process
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants