blackjax-devs/blackjax

Incorrect Doc for `VIAlgorithm` Class

gil2rok opened this issue · 1 comments

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

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