[nnx] simplify readme #3707
Merged
[nnx] simplify readme #3707
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #3707 +/- ##
==========================================
- Coverage 59.10% 59.10% -0.01%
==========================================
Files 103 103
Lines 12426 12454 +28
==========================================
+ Hits 7345 7361 +16
- Misses 5081 5093 +12 ☔ View full report in Codecov by Sentry. |
cgarciae
force-pushed
the
nnx-simplify-readme
branch
from
8f9e760
to
26479fc
Compare
chiamp
reviewed
Feb 22, 2024
chiamp
reviewed
Feb 22, 2024
Comment on lines
+145
to
+146
| * [Using TrainState](https://github.com/google/flax/tree/main/flax/experimental/nnx/examples/toy_examples/03_train_state.py): Shows how to train a simple model using the functional API with the help of `TrainState`. | ||
| * [Training a VAE](https://github.com/google/flax/tree/main/flax/experimental/nnx/examples/toy_examples/05_vae.py): Shows how to train a VAE on the binarized MNIST dataset, uses the functional API, `TrainState`, and shows how to use capture intermediate values to retrieve `kl_loss`. |
There was a problem hiding this comment.
Should 05_vae.py be renamed to 04_vae.py (as well as decrementing all subsequent toy example numbers)? The number 04 seems to be missing from the toy_examples.
There was a problem hiding this comment.
Yeah there is a bit of an inconsistency here. I don't think its super important but we sould fix it at some point :)
chiamp
approved these changes
Feb 22, 2024
Co-authored-by: Marcus Chiam <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Simplifies NNX's readme.