Skip to content

Add docstrings to nnx filterlib filter classes#5474

Open
santihdzs wants to merge 1 commit into
google:mainfrom
santihdzs:docs/nnx-filterlib-docstrings
Open

Add docstrings to nnx filterlib filter classes#5474
santihdzs wants to merge 1 commit into
google:mainfrom
santihdzs:docs/nnx-filterlib-docstrings

Conversation

@santihdzs
Copy link
Copy Markdown

@santihdzs santihdzs commented May 29, 2026

What does this PR do?

The filter classes in flax.nnx.filterlib (WithTag, PathContains, OfType, Any, All, Not, Everything, Nothing) are exported and appear in the NNX API reference but currently render with no docstrings. This adds a docstring to each, with descriptions based on the Filters guide and Attributes: sections for the dataclass filters. Docs only, no behavioral changes.

Part of #5161.

Checklist

cc @vfdev-5

Rendered docs: https://flax--5474.org.readthedocs.build/en/5474/api_reference/flax.nnx/filterlib.html

Copy link
Copy Markdown
Collaborator

@vfdev-5 vfdev-5 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

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.

2 participants