Skip to content

[WIP] Reorganize and update documentation #5059

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

Merged
merged 16 commits into from
Nov 24, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/Advanced_usage_of_Aesara_in_PyMC.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
:orphan:

(Advanced_usage_of_Aesara_in_PyMC)
..
_referenced in docs/source/notebooks/table_of_contents_tutorials.js

Expand Down
1 change: 1 addition & 0 deletions docs/source/community.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
(community)=
# Community

:::{list-table}
Expand Down
5 changes: 3 additions & 2 deletions docs/source/glossary.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
(glossary)=
# Glossary

A glossary of common terms used throughout the PyMC documentation and examples.
Expand Down Expand Up @@ -77,9 +78,9 @@ GLM

[Maximum a Posteriori](https://en.wikipedia.org/wiki/Maximum_a_posteriori_estimation)
[MAP](https://en.wikipedia.org/wiki/Maximum_a_posteriori_estimation)
It is a point-estimate of an unknown quantity, that equals the mode of the posterior distribution.
It is a point-estimate of an unknown quantity, that equals the mode of the posterior distribution.

If the prior distribution is a flat distribution, the MAP method is numerically equivalent to the {term}`Maximum Likelihood Estimate` (MLE).
If the prior distribution is a flat distribution, the MAP method is numerically equivalent to the {term}`Maximum Likelihood Estimate` (MLE).
When the prior is not flat the MAP estimation can be seen as a regularized version of the MLE.

- For a concise comparison between {term}`MLE` and {term}`MAP`, consider Deep Learning by Ian Goodfellow, chapter 5.6.1 or [Machine Learning: a Probabilistic Perspective](https://probml.github.io/pml-book/book1.html) by Kevin Murphy.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
sd_hide_title: true
---

(index)=
# PyMC Documentation

:::{card}
Expand Down
1 change: 1 addition & 0 deletions docs/source/installation.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
(installation)=
# Installation

To install PyMC, select the operating system where you want to perform the installation.
Expand Down
1 change: 1 addition & 0 deletions docs/source/learn/books.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
(books)=
# Books

TODO add books
1 change: 1 addition & 0 deletions docs/source/learn/examples.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
(examples)=
# Notebooks

TODO add "core" notebooks:
Expand Down
1 change: 1 addition & 0 deletions docs/source/learn/videos_and_podcasts.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
(videos_and_podcasts)=
# Videos and Podcasts

:::{card} PyMC Developers Youtube channel
Expand Down
6 changes: 3 additions & 3 deletions docs/source/learning.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,15 +30,15 @@ A great introductory book written by a maintainer of PyMC. It provides a hands-o
### {octicon}`mortar-board;1em;sd-text-info` Tutorial notebooks

#### Getting started
The {ref}`examples/getting_started` notebook in our documentation shows the PyMC 4.0 code in action
The {ref}`getting_started` notebook in our documentation shows the PyMC 4.0 code in action

#### General Linear Models: Linear regression

The {ref}`examples/GLM_linear` notebook provides a gentle introduction to Bayesian linear regression and how it differs from the frequentist approach, and showcases how to implement it using PyMC.
The {ref}`GLM_linear` notebook provides a gentle introduction to Bayesian linear regression and how it differs from the frequentist approach, and showcases how to implement it using PyMC.

#### Comparing models

The {ref}`examples/model_comparison` notebook demonstrates the use of model comparison criteria in PyMC.
The {ref}`model_comparison` notebook demonstrates the use of model comparison criteria in PyMC.

#### Validating a model using prior and posterior predictive checks

Expand Down