Skip to content
Closed
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
Prev Previous commit
Next Next commit
remove mentions to flat arrays in docstrings
  • Loading branch information
rlouf committed Apr 3, 2020
commit bee1925f77b973ad97293e60866ce8b1d5422de0
5 changes: 0 additions & 5 deletions mcx/inference/adaptive.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,6 @@
The Stan Manual [1]_ is a very good reference on automatic tuning of
parameters used in Hamiltonian Monte Carlo.

.. note:
This is a "flat zone": values used to update the step size or the mass
matrix are 1D arrays. Raveling/unraveling logic should happen at a higher
level.

.. [1]: "HMC Algorithm Parameters", Stan Manual
https://mc-stan.org/docs/2_20/reference-manual/hmc-algorithm-parameters.html
"""
Expand Down
4 changes: 0 additions & 4 deletions mcx/inference/integrators.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,6 @@
manifolds.

IntegratorStep does not need to compute and return the logprob!

.. note:
This file is a "flat zone": position and momentum are one-dimensional arrays.
Any raveling/unraveling logic must be placed at a higher level.
"""
from functools import partial
from typing import Callable, NamedTuple
Expand Down
4 changes: 0 additions & 4 deletions mcx/inference/kernels.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
"""Sampling kernels.

.. note:
This file is a "flat zone": positions and logprobs are 1 dimensional
arrays. Raveling and unraveling logic must happen outside.
"""
from typing import Callable, NamedTuple, Tuple

Expand Down
4 changes: 0 additions & 4 deletions mcx/inference/metrics.py
Original file line number Diff line number Diff line change
@@ -1,8 +1,4 @@
"""Generate dynamics on a Euclidean Manifold or Riemannian Manifold.

.. note:
This file is a "flat zone": positions and logprobs are 1 dimensional
arrays. Raveling and unraveling logic must happen outside.
"""
from typing import Callable, Tuple

Expand Down
3 changes: 0 additions & 3 deletions mcx/inference/warmup.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,4 @@
"""Warming up the chain.

.. note:
This is a "flat zone": all positions are 1D array.
"""
from functools import partial
from typing import Callable, Tuple
Expand Down