NVIDIA / NVIDIA/Megatron-LM

Overhaul documentation

Open
#2,619 1 comment 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
17.9k
Forks
4.5k
Avg merge
4d 3h
Merged PRs (30d)
272

Description

- [x] Migrate docs to new Sphinx
- [x] Fix docs deployment to website
- Ideally this includes a way to deploy a beta version of our docs
- [x] Switch docs from automodule to autodoc2
- [x] Deploy skeleton layout
- [x] Migrate existing docs to new layout
- [ ] Write new docs where we have gaps
- Megatron in 15 minutes
- ProcessGroupCollection
- ...
- [ ] Refresh docs
- [ ] `docs/api-guide/models/models.md`
- [ ] `megatron/core/transformer/moe/README.md`
- too long but has good content
- [x] Make MLM README succinct
- [x] Publish quarterly roadmap
- [ ] Publish first blog post about a new feature
- [ ] Track doc metrics
- e.g. page views
- [ ] https://github.com/NVIDIA/Megatron-LM/issues/2653

On the fence:

- [ ] Force docs to be within `docs` top-level directory
- [ ] Add @megnvidia to all PRs with `docs-only` label

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.