[pallas] Added more documentation for grid and BlockSpec. #22134
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
gnecula
force-pushed
the
pallas_doc
branch
2 times, most recently
from
5e86ddc
to
2940cec
Compare
gnecula
requested review from
superbobry,
sharadmv,
ayaka14732,
justinjfu and
apaszke
superbobry
reviewed
Jun 27, 2024
superbobry
approved these changes
Jun 27, 2024
google-ml-butler
bot
added
kokoro:force-run
pull ready
apaszke
reviewed
Jun 28, 2024
The starting point was the text in pipelining.md, where I replaced it now with a reference to the separate grid and BlockSpec documentation. The grids and BlockSpecs are also documented in the quickstart.md, which I mostly left alone because it was good enough for a simple example. I have also attempted to add a few docstrings.
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.
The starting point was the text in pipelining.md, where I replaced it now with a reference to the separate grid and BlockSpec documentation.
The grids and BlockSpecs are also documented in the quickstart.md, which I mostly left alone because it was good enough for a simple example.
I have also attempted to add a few docstrings.
The rendered documentation is at: https://jax--22134.org.readthedocs.build/en/22134/pallas/index.html and https://jax--22134.org.readthedocs.build/en/22134/jax.experimental.pallas.html#module-jax.experimental.pallas.