search

blackjax-devs / blackjax

BlackJAX is a Bayesian Inference library designed for ease of use, speed and modularity.
https://blackjax-devs.github.io/blackjax/
Apache License 2.0
806 stars 105 forks source link

Incorrect Doc for `VIAlgorithm` Class #700

Open gil2rok opened 3 months ago

gil2rok commented 3 months ago

The VIAlgorithm class has code and documentation that do not match in base.py here.

The documentation indicates this class is instantiated with a tuple of approximation and sample functions. However, the code indicates this class is instantiated with a tuple of init, step, and sample functions.

Either the doc or code should change to be consistent. IMO the doc should change as documentation simply describes what the code does.

Screenshot 2024-06-23 at 3 14 13 PM
gil2rok commented 3 months ago

Some VI algorithms take an Optimizer (e.g. mean field, pathfinder) even though the doc does not specify this.