Document the convention that the first axis is time whenever a multi-dimensional array is a timeseries

CDCgov / PyRenew

Python package for multi-signal Bayesian renewal modeling with JAX and NumPyro.

https://cdcgov.github.io/PyRenew/

Apache License 2.0

14 stars 2 forks source link

Closed dylanhmorris closed 4 days ago

dylanhmorris commented 5 days ago

@sbidari would you be up for this?

sbidari commented 5 days ago

Sure, are you thinking of readme type file? We could also add a short tutorial/demo demonstrating this.

dylanhmorris commented 5 days ago

In the first instance I'd put it in both the main documentation and developer documentation. Tutorial demo is a nice to have but can wait.