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
Fix the documentation of our flax modules / NNs to be finally readable #1641
Conversation
Also solves all build errors of our documentation, so now we could theoretically make it error in CI if someone does not write docs correctly... |
unless @gcarleo is against, I'm merging this asap because it's a big improvement... |
I like it of course, but is there a way to get the methods/attributes of the models ? say, n_parameters etc |
Those are just the flax models. Before this PR the documentation is essentially unreadable between all the inherited members and stuff that is misrendered. That's my best effort for now :) before taking a break from all those PRs for a bit. |
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## master #1641 +/- ##
===========================================
- Coverage 82.50% 50.25% -32.26%
===========================================
Files 279 279
Lines 16762 16260 -502
Branches 2543 2532 -11
===========================================
- Hits 13830 8171 -5659
- Misses 2309 7449 +5140
- Partials 623 640 +17
☔ View full report in Codecov by Sentry. |
ah yes sorry I meant MCState.n_parameters but that's not a problem, ok to merge! thanks |
Compare current website https://netket.readthedocs.io/en/latest/api/_generated/models/netket.models.RBM.html#netket.models.RBM
with this PR
https://netket--1641.org.readthedocs.build/en/1641/api/_generated/models/netket.models.RBM.html#netket.models.RBM
Also
master MLP
https://netket.readthedocs.io/en/latest/api/_generated/nn/netket.nn.blocks.MLP.html#netket.nn.blocks.MLP
this PR MLP
https://netket--1641.org.readthedocs.build/en/1641/api/_generated/nn/netket.nn.blocks.MLP.html#netket.nn.blocks.MLP