Skip to content

Commit 16a70b4

Browse files
authored
Migrate all manual docs to auto generation (#5617)
* feat(docs): populate pytorch-training configs with release notes fields - Add announcements, packages, and tags to all 16 pytorch-training configs (2.6-2.9, GPU/CPU, EC2/SageMaker) - Add display_names for gdrcopy, torchtext, torchserve, openmpi to global.yml - Package versions extracted from Dockerfiles on master branch - Tags from GitHub release tags (excluding datetime and v1.0 tags) Signed-off-by: sirutBuasai <sirutbuasai27@outlook.com> * feat(docs): populate pytorch-inference configs with release notes fields - Add announcements, packages, and tags to all 4 pytorch-inference configs (2.6, GPU/CPU, EC2/SageMaker) - Package versions extracted from Dockerfiles on master branch - Tags from GitHub release tags (excluding datetime and v1.0 tags) Signed-off-by: sirutBuasai <sirutbuasai27@outlook.com> * feat(docs): populate pytorch-training-arm64 config with release notes fields - Add announcements, packages, and tags to 2.7-gpu-ec2.yml - Package versions extracted from Dockerfile on master branch - Tags from GitHub release tags (excluding datetime and v1.0 tags) Signed-off-by: sirutBuasai <sirutbuasai27@outlook.com> * feat(docs): populate pytorch-inference-arm64 configs with release notes fields - Add announcements, packages, and tags to 3 configs (2.6 GPU/CPU EC2, CPU SageMaker) - Remove incorrect 2.6-gpu-sagemaker.yml (ARM64 SageMaker is CPU-only) - Add 2.6-cpu-sagemaker.yml for ARM64 SageMaker CPU - Package versions extracted from Dockerfiles on master branch - Tags from GitHub release tags (excluding datetime and v1.0 tags) Signed-off-by: sirutBuasai <sirutbuasai27@outlook.com> * feat(docs): populate base configs with release notes fields - Add announcements, packages, and tags to 3 base configs (12.8, 12.9, 13.0) - Fix OS version from ubuntu24.04 to ubuntu22.04 for 12.8 - Package versions extracted from Dockerfiles on master branch - Tags from GitHub release tags (excluding datetime and v1.0 tags) Signed-off-by: sirutBuasai <sirutbuasai27@outlook.com> * feat(docs): populate sglang, vllm, vllm-arm64 configs with release notes fields - Add announcements, packages, and tags to sglang (1 file), vllm (2 files), vllm-arm64 (1 file) - Fix OS version from ubuntu24.04 to ubuntu22.04 for sglang - Package versions from GitHub release tags - Tags from GitHub release tags (excluding datetime and v1.0 tags) Signed-off-by: sirutBuasai <sirutbuasai27@outlook.com> * feat(docs): add patch versions and cudnn/nccl to base, sglang, vllm configs Base containers: - Rename 12.8 to 12.8.0, add 12.8.1 (ubuntu24.04) - Add cudnn and nccl versions from install_cuda.sh SGLang: - Add patch versions: 0.5.5, 0.5.6, 0.5.7, 0.5.8 vLLM: - Rename 0.13 to 0.13.0 vLLM ARM64: - Rename 0.10 to 0.10.2 Signed-off-by: sirutBuasai <sirutbuasai27@outlook.com> * feat(docs): add vLLM 0.14.0 configs for EC2 and SageMaker Signed-off-by: sirutBuasai <sirutbuasai27@outlook.com> * feat(docs): add CUDA stack versions (cudnn, nccl) to vLLM and SGLang configs - vLLM 0.13.0/0.14.0: cuda 12.9.1, cudnn 9.15.0, nccl 2.28.3 - vLLM-ARM64 0.10.2: cuda 12.9.1, cudnn 9.10.2, nccl 2.27.3 - SGLang 0.5.5-0.5.8: cuda 12.9.1, cudnn 9.16.0.29, nccl 2.28.3 Versions sourced from: - vLLM: PyTorch 2.9.x bundled dependencies - SGLang: Explicit pip installs in Dockerfile Signed-off-by: sirutBuasai <sirutbuasai27@outlook.com> * feat(docs): populate TensorFlow 2.19 configs with release notes fields - tensorflow-training: 2.19 GPU (cu125) and CPU for SageMaker - tensorflow-inference: 2.19 GPU (cu122) and CPU for SageMaker - tensorflow-inference-arm64: 2.19 CPU for SageMaker GPU packages: cuda, cudnn, nccl (inference only) Common packages: tensorflow, python, openmpi (training), efa (training GPU) Signed-off-by: sirutBuasai <sirutbuasai27@outlook.com> * migrate all docs Signed-off-by: sirutBuasai <sirutbuasai27@outlook.com> * migrate all docs Signed-off-by: sirutBuasai <sirutbuasai27@outlook.com> * remove release notes Signed-off-by: sirutBuasai <sirutbuasai27@outlook.com> * remove release notes Signed-off-by: sirutBuasai <sirutbuasai27@outlook.com> * addd support policy sorting Signed-off-by: sirutBuasai <sirutbuasai27@outlook.com> --------- Signed-off-by: sirutBuasai <sirutbuasai27@outlook.com>
1 parent 507ddf2 commit 16a70b4

File tree

102 files changed

+1008
-1894
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

102 files changed

+1008
-1894
lines changed

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ __pycache__
88

99
# Generated docs
1010
docs/tutorials
11-
# docs/releasenotes/*/
11+
docs/releasenotes/*/
1212
docs/reference/available_images.md
1313
docs/reference/support_policy.md

.kiro/steering/docs.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,9 @@ from utils import render_table
172172
# Build a complete row (uses img.get_display() internally)
173173
row = build_image_row(img, columns) # ["PyTorch 2.9", "py312", ...]
174174

175+
# Build row with field overrides (e.g., for version consolidation in support_policy)
176+
row = build_image_row(img, columns, overrides={"version": "2.9"})
177+
175178
# Render markdown table
176179
table = render_table(headers, rows)
177180
```
@@ -216,7 +219,7 @@ To generate release notes for an image, add the following fields to the image co
216219
217220
```yaml
218221
# Required for release notes generation (both must be present)
219-
announcement:
222+
announcements:
220223
- "Introduced containers for PyTorch 2.9 for Training"
221224
- "Added Python 3.12 support"
222225

@@ -236,14 +239,14 @@ optional:
236239
**Required fields for release notes** are defined in `constants.py`:
237240

238241
```python
239-
RELEASE_NOTES_REQUIRED_FIELDS = ["announcement", "packages"]
242+
RELEASE_NOTES_REQUIRED_FIELDS = ["announcements", "packages"]
240243
```
241244

242245
The `packages` field uses keys that map to display names in `global.yml` under `display_names`.
243246

244247
### Release Notes Generation
245248

246-
Release notes are automatically generated for images that have all required fields (`announcement` and `packages`).
249+
Release notes are automatically generated for images that have all required fields (`announcements` and `packages`).
247250

248251
**Output structure:**
249252

@@ -275,7 +278,7 @@ This separation uses the `ImageConfig.is_supported` property.
275278
276279
**Generated release note sections:**
277280
278-
1. **Announcement** - Bullet list from `announcement` field
281+
1. **Announcements** - Bullet list from `announcements` field
279282
1. **Core Packages** - Table from `packages` field (keys mapped via `display_names`)
280283
1. **Security Advisory** - Hardcoded section with link to AWS Security Bulletin
281284
1. **Reference** - Docker image URIs (private ECR + public ECR if `public_registry: true`) and links to available_images.md and support_policy.md
@@ -357,11 +360,16 @@ table_order:
357360

358361
The `framework_groups` configuration consolidates support policy rows by framework. Repositories in the same group are combined into a single row using the framework name (e.g., "PyTorch").
359362

363+
**Version Display:**
364+
365+
- Images with the same major.minor version (e.g., `2.6.0` and `2.6.1`) are consolidated into a single row displayed as `2.6` if they have identical GA/EOP dates
366+
- If patch versions have different GA/EOP dates, each is displayed separately with full version (e.g., `2.6.0`, `2.6.1`) and a warning is logged
367+
360368
**Requirements:**
361369

362-
- All repositories in a group that have a given version must have identical GA/EOP dates
370+
- All repositories in a group that have a given full version (X.Y.Z) must have identical GA/EOP dates
363371
- Missing versions in some repositories are allowed (only present repos are consolidated)
364-
- A `ValueError` is raised if dates differ within a group for the same version
372+
- A `ValueError` is raised if dates differ within a group for the same full version
365373

366374
To add a new framework group, add an entry to `framework_groups` with the framework name as key and list of repositories as value.
367375

docs/DEVELOPMENT.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,12 @@ ga: "2025-10-15" # General Availability date
8585
eop: "2026-10-15" # End of Patch date
8686
```
8787

88-
**Validation:** All images in the same framework group with the same version must have identical GA/EOP dates.
88+
**Version Consolidation:**
89+
90+
- Images with the same major.minor version (e.g., `2.6.0` and `2.6.1`) are consolidated into a single row displayed as `2.6` if they have identical GA/EOP dates
91+
- If patch versions have different GA/EOP dates, each is displayed separately with full version (e.g., `2.6.0`, `2.6.1`) and a warning is logged
92+
93+
**Validation:** All images in the same framework group with the same full version (X.Y.Z) must have identical GA/EOP dates.
8994

9095
______________________________________________________________________
9196

docs/releasenotes/base/cuda-12.8-ec2.md

Lines changed: 0 additions & 46 deletions
This file was deleted.

docs/releasenotes/base/cuda-12.9-ec2.md

Lines changed: 0 additions & 46 deletions
This file was deleted.

docs/releasenotes/base/cuda-13.0-ec2.md

Lines changed: 0 additions & 46 deletions
This file was deleted.

docs/releasenotes/base/index.md

Lines changed: 0 additions & 21 deletions
This file was deleted.

docs/releasenotes/pytorch/2.4-graviton-ec2-ecs-eks.md

Lines changed: 0 additions & 73 deletions
This file was deleted.

docs/releasenotes/pytorch/2.4-graviton-sagemaker.md

Lines changed: 0 additions & 52 deletions
This file was deleted.

0 commit comments

Comments
 (0)