google / google/flax

For some reason these imports are elided on read the docs

Open
#3,799 1 comment 0 reactions 0 assignees View on GitHub
Priority: P2 - no schedule
Dominant language
Jupyter Notebook
Stars
7.3k
Forks
833
Avg merge
5h 11m
Merged PRs (30d)
5

Description

I mean, they are inferable by the reader, but it looks like they are intended to be visible in the finished product and getting eaten somewhere along the publication tool chain?
![Screenshot 2024-03-29 8 28 11 PM](https://github.com/google/flax/assets/1413/5a388ec5-4b49-463f-9ab1-b4baba285c95)

I would also say that this tutorial reads a little bit bouncier between levels of technical explanation than one might hope. I think the call out to the reader to supply their own loss function is more of a math textbook kind of exercise left to the reader than something that belongs in explanatory documentation. The bit about BatchNormalization being dependent on batch size and therefore not properly vectorizable also seems like a theoretical concern that should be left out or handled differently.
https://github.com/google/flax/blob/514c11199152fab44de6002983f44e6b49aa0622/docs/guides/flax_fundamentals/state_params.rst?plain=1#L12

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.