Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Incorrect Doc for VIAlgorithm Class #700

Open
gil2rok opened this issue Jun 23, 2024 · 1 comment
Open

Incorrect Doc for VIAlgorithm Class #700

gil2rok opened this issue Jun 23, 2024 · 1 comment

Comments

@gil2rok
Copy link
Contributor

gil2rok commented Jun 23, 2024

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
Copy link
Contributor Author

gil2rok commented Jun 28, 2024

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant