https://github.com/GPflow/GPflow
Revision 3e8bf1822003feaee9f4ca9e46cc06e4a81d041e authored by Vincent Dutordoir on 25 February 2020, 17:39:09 UTC, committed by GitHub on 25 February 2020, 17:39:09 UTC
This PR (superseding #1271) enables auto-generation of all of GPflow's documentation. Upon a new merge in `develop`, we trigger our new repo [GPflow/docs](https://github.com/GPflow/docs) to:
- copy the complete content of GPflow/doc
- compile the notebooks `.ipynb` from the `.pct.py` files
- create the `rst` files for the api documentation required for readthedocs.

#### TODO:
- [ ] Allow for documentation at different tags of the source code.
1 parent 167973b
Raw File
Tip revision: 3e8bf1822003feaee9f4ca9e46cc06e4a81d041e authored by Vincent Dutordoir on 25 February 2020, 17:39:09 UTC
Auto-generate docs in GPflow/docs (#1275)
Tip revision: 3e8bf18
GLOSSARY.md
## Glossary

GPflow does not always follow standard Python naming conventions,
and instead tries to apply the notation in the relevant GP papers.\
The following is the convention we aim to use in the code.

---

<dl>
  <dt>GPR</dt>
  <dd>Gaussian process regression</dd>

  <dt>SVGP</dt>
  <dd>stochastic variational inference for Gaussian process models</dd>

  <dt>Shape constructions [..., A, B]</dt>
  <dd>the way of describing tensor shapes in docstrings and comments. Example: <i>[..., N, D, D]</i>, this is a tensor with an arbitrary number of leading dimensions indicated using the ellipsis sign, and the last two dimensions are equal</dd>

  <dt>X</dt>
  <dd>(and variations like Xnew) refers to input points; always of rank 2, e.g. shape <i>[N, D]</i>, even when <i>D=1</i></dd>

  <dt>Y</dt>
  <dd>(and variations like Ynew) refers to observed output values, potentially with multiple output dimensions; always of rank 2, e.g. shape <i>[N, P]</i>, even when <i>P=1</i></dd>

  <dt>Z</dt>
  <dd>refers to inducing points</dd>

  <dt>M</dt>
  <dd>stands for the number of inducing features (e.g. length of Z)</dd>

  <dt>N</dt>
  <dd>stands for the number of data or minibatch size in docstrings and shape constructions</dd>

  <dt>P</dt>
  <dd>stands for the number of output dimensions in docstrings and shape constructions</dd>

  <dt>D</dt>
  <dd>stands for the number of input dimensions in docstrings and shape constructions</dd>
</dl>
back to top