Restructure spmd_types documentation into a Sphinx site - #4
Closed
ezyang wants to merge 1 commit into
Closed
Conversation
Summary: # Human summary This starts writing some true docs for `spmd_types`. I slaved away on `key_concepts.md` and `local_spmd_types.md` so those would be the ones to focus in on, but there's also lots of other bits an bobs here and there. # AI summary Reorganizes the spmd_types docs from two top-level Markdown files into a proper Sphinx documentation site under `docs/`. `DESIGN.md` moves to `docs/design.md` (the full type-system specification), and the old `MEGATRON_QUICKSTART.md` is folded into the new `docs/local_spmd_types.md`, which carries the hands-on porting guide, the Megatron-to-spmd_types function mapping table, and the Invariant-vs-Replicate advice. New pages add `docs/index.md`, `docs/key_concepts.md`, `docs/global_spmd_types.md`, and an autodoc-backed API reference under `docs/api/`. `docs/conf.py` configures Sphinx (MyST + napoleon + autodoc, RTD theme). `README.md` and `CLAUDE.md` references are updated to the new paths, `CONTRIBUTING.md` headings are normalized, and the `PartitionSpec` / `TensorSharding` docstrings in `types.py` are reformatted as literal blocks so they render correctly under autodoc. `docs/_build/` is gitignored and a `# noautodeps` `docs/BUCK` is added so the Sphinx `conf.py` is not buckified. Reviewed By: pianpwk Differential Revision: D107149885
meta-cla
Bot
added
the
CLA Signed
Contributor
|
@ezyang has exported this pull request. If you are a Meta employee, you can view the originating Diff in D107149885. |
Contributor
|
This pull request has been merged in 8d9235e. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary:
Human summary
This starts writing some true docs for
spmd_types. I slaved away onkey_concepts.mdandlocal_spmd_types.mdso those would be the ones to focus in on, but there's also lots of other bits an bobs here and there.AI summary
Reorganizes the spmd_types docs from two top-level Markdown files into a proper Sphinx documentation site under
docs/.DESIGN.mdmoves todocs/design.md(the full type-system specification), and the oldMEGATRON_QUICKSTART.mdis folded into the newdocs/local_spmd_types.md, which carries the hands-on porting guide, the Megatron-to-spmd_types function mapping table, and the Invariant-vs-Replicate advice. New pages adddocs/index.md,docs/key_concepts.md,docs/global_spmd_types.md, and an autodoc-backed API reference underdocs/api/.docs/conf.pyconfigures Sphinx (MyST + napoleon + autodoc, RTD theme).README.mdandCLAUDE.mdreferences are updated to the new paths,CONTRIBUTING.mdheadings are normalized, and thePartitionSpec/TensorShardingdocstrings intypes.pyare reformatted as literal blocks so they render correctly under autodoc.docs/_build/is gitignored and a# noautodepsdocs/BUCKis added so the Sphinxconf.pyis not buckified.Reviewed By: pianpwk
Differential Revision: D107149885