Feature Request: Example Documentation

[marcvanzee]

Discussed in #2779

^{Originally posted by shenoynikhil January 8, 2023}
In the API Reference, is it possible to have an example for each module. It's generally easy to understand the usage from an example.

The request is inspired from pytorch (example shared below for torch.nn.Conv2D Link)

I am also willing to help out to improve the documentation if I can get some support :).

[IvyZX]

Most of the modules actually are used in flax/examples or in some documentation tutorials.
For example, from what I've seen for now, Dense and Conv are used in Getting Started, and BatchNorm and Dropout have their own guides.

It might be a good practice to at least put a link on the docstring so that users can see it from API Reference.

[shenoynikhil]

I'll be glad to help improve the documentation.

[IvyZX]

Thank you @shenoynikhil for offering help! When you have a PR please let us know.

[cgarciae]

There are efforts on this direction (e.g. #2792) however it will take time to improve all docstrings so I set the tag for this issue to eventual.