Skip to content

Commit

Permalink
add multidim array convention in dev documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sbidari committed Sep 13, 2024
1 parent 3d06ab9 commit 6bfe430
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions docs/source/developer_documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,10 @@ PyRenew Principles
- Using default site names in a ``RandomVariable`` is discouraged. Only use default site names at the ``Model`` level.
- Use ``DeterministicVariable``\ s instead of constants within a model.

- Multidimensional array conventions

- In a multidimensional array of timeseries, time is always the first dimension. By default, `numpyro.scan` builds by augmenting the first dimension, and variables are often scanned over time, thus this convention makes default output of scan over time sensible.

Adding Documentation to Sphinx
------------------------------

Expand Down

0 comments on commit 6bfe430

Please sign in to comment.