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

Don't recommend mixing setup and compact in docs. #2018

Merged
merged 1 commit into from
Mar 29, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 0 additions & 6 deletions docs/design_notes/setup_or_nncompact.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,12 +80,6 @@ Reasons to prefer using ``setup``:
3. Allows defining more than one "forward pass" method
(see :class:`MultipleMethodsCompactError <flax.errors.MultipleMethodsCompactError>`)

**NOTE**: You can also define a module using both ``setup`` and
``nn.compact``. You'd put submodules and variables shared across
methods in ``setup``. Then, one method alone can be annotated
with ``nn.compact`` and add additional
submodules and variables that are not available in any other methods.




Expand Down