Add introductory kernel notebook and change style file path in notebooks #331
Conversation
Main change is to add a notebook introducing the concept of a kernel for those new to Gaussian processes. This focuses on mathematical intuition and introduces useful concepts such as covariance matrices and positive-definiteness. Also noted that the README file for writing documentation hadn't been updated since switching to using MkDocs, so updated it to reflect these changes. Also found that the relative path to the style file for the notebooks caused issues when running the `poetry run mkdocs serve` command. Now instead of using a relative path to the style file, we point to the URL of the style file directly. I have copied the style file into the `_static` directory, and a future PR will point to this URL instead. Finally made a few other minor edits: - Updated docstring for the periodic kernel as it was incomplete. - Made some minor fixes to a few other docstrings I found flaws in.
There was a problem hiding this comment.
Really nice work @Thomas-Christie! I've left comments.
nit: can you make all markdown lines 88 characters long please? It makes reviewing much easier. Most code editors will have a hard wrap option that should automate this for you.
|
Thanks a lot for the detailed feedback @thomaspinder . I have addressed your comments in a new commit. |
|
Minor commit added - had forgotten to add the reference for the Matérn kernel. |
|
Approved. I can see @henrymoss has added himself as a reviewer. Once his review cycle is complete, I am happy for this to be merged. |
|
Also, now that we have an introductory kernel notebook, shall we rename the existing kernels.py to building_new_kernels.py or something similar? |
I have renamed the file to |
Added an extra section to the kernel introduction notebook detailing how one can create new kernels by adding/multiplying two existing kernels. Also added an example using the Mauna Loa CO2 dataset. Also renamed the original 'kernels.py' notebook to 'constructing_new_kernels.py' and edited references to this notebook.
|
@henrymoss @thomaspinder thanks for the feedback. I have addressed Henry's feedback, adding a section using the Mauna Loa CO2 dataset and a section on composing new kernels through addition/multiplication of existing kernels. I have also moved the section on Gram matrices etc. closer to the start. Have also renamed the original 'kernels.py' notebook to 'constructing_new_kernels.py' for clarity (and have renamed references to this file). Are you happy for me to merge this now? |
Type of changes
Checklist
poetry run pre-commit run --all-files --show-diff-on-failurebefore committing.Description
Main change is to add a notebook introducing the concept of a kernel for those new to Gaussian processes. This focuses on mathematical intuition and introduces useful concepts such as covariance matrices and positive-definiteness.
Also noted that the README file for writing documentation hadn't been updated since switching to using MkDocs, so updated it to reflect these changes.
Also found that the relative path to the style file for the notebooks caused issues when running the
poetry run mkdocs servecommand. Now instead of using a relative path to the style file, we point to the URL of the style file directly. I have copied the style file into the_staticdirectory, and a future PR will point to this URL instead.Finally made a few other minor edits:
mkdocs.ymlfile.Issue Number: #269