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

Fix the documentation of our flax modules / NNs to be finally readable #1641

Merged
merged 14 commits into from Nov 7, 2023

Conversation

@PhilipVinc PhilipVinc changed the title Fix the documentation of our flax modules / NNs to be sensible Fix the documentation of our flax modules / NNs to be finally readable Nov 7, 2023
@PhilipVinc
Copy link
Member Author

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...

@PhilipVinc
Copy link
Member Author

unless @gcarleo is against, I'm merging this asap because it's a big improvement...

@gcarleo
Copy link
Member

gcarleo commented Nov 7, 2023

I like it of course, but is there a way to get the methods/attributes of the models ? say, n_parameters etc

@PhilipVinc
Copy link
Member Author

MCState.n_parameters ? or some methods in https://flax.readthedocs.io/en/latest/api_reference/flax.linen/module.html#flax.linen.Module

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.

Copy link

codecov bot commented Nov 7, 2023

Codecov Report

Attention: 6 lines in your changes are missing coverage. Please review.

Comparison is base (8ec2f90) 82.50% compared to head (4fbcbf6) 50.25%.

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     
Files Coverage Δ
netket/experimental/logging/__init__.py 100.00% <100.00%> (ø)
netket/experimental/logging/hdf5_log.py 64.70% <100.00%> (+0.42%) ⬆️
netket/experimental/operator/pyscf.py 82.45% <100.00%> (ø)
netket/models/deepset.py 44.44% <ø> (-50.30%) ⬇️
netket/models/equivariant.py 45.96% <ø> (-45.55%) ⬇️
netket/nn/blocks/deepset.py 42.85% <ø> (-46.98%) ⬇️
netket/nn/blocks/symmetry_sum.py 45.83% <ø> (-54.17%) ⬇️
netket/nn/symmetric_linear.py 61.34% <ø> (-27.65%) ⬇️
netket/utils/holomorphic.py 57.89% <ø> (-42.11%) ⬇️
netket/vqs/base.py 35.48% <ø> (-60.22%) ⬇️
... and 7 more

... and 236 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@gcarleo
Copy link
Member

gcarleo commented Nov 7, 2023

ah yes sorry I meant MCState.n_parameters but that's not a problem, ok to merge! thanks

@PhilipVinc PhilipVinc merged commit 3cba5f4 into netket:master Nov 7, 2023
7 of 9 checks passed
@PhilipVinc PhilipVinc deleted the pv/flaxdocs branch November 7, 2023 15:00
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

Successfully merging this pull request may close these issues.

None yet

2 participants