normal-computing / thermox

Exact OU processes with JAX
Apache License 2.0
24 stars 3 forks source link

Minor documentation inconsistency #23

Closed denismelanson closed 1 month ago

denismelanson commented 1 month ago

Most functions in linalg module have the following inconsistency. In the doc string, the num_samples argument is said to be a float, while the type annotation says it should be an integer.

The same functions have an unclear doc string regarding their burnin parameter. I suggest changing "burnin: burn-in, steps before which samples are not collected." to "burnin: integer, time-step index corresponding to the end of the burn-in period. Steps before this are not collected."