Skip to content

Commit cb829cb

Browse files
committed
update documentation
Signed-off-by: sirutBuasai <sirutbuasai27@outlook.com>
1 parent 1d45013 commit cb829cb

File tree

2 files changed

+81
-9
lines changed

2 files changed

+81
-9
lines changed

.kiro/steering/docs.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -31,11 +31,16 @@ docs/src/
3131
│ ├── pytorch-training-neuronx/
3232
│ │ └── 2.9-neuronx-sdk2.27.1.yml
3333
│ └── ...
34-
├── global.yml # Shared terminology and configuration
34+
├── legacy/ # Historical support data
35+
│ └── legacy_support.yml
36+
├── constants.py # Path constants and global variables
3537
├── generate.py # Generation logic
38+
├── global.yml # Shared terminology and configuration
3639
├── hooks.py # MkDocs hooks
40+
├── logger.py # Logging configuration
3741
├── macros.py # MkDocs macros
38-
└── utils.py # Utilities
42+
├── main.py # CLI entry point
43+
└── utils.py # Reusable helper functions
3944
```
4045

4146
### Adding a New Image
@@ -114,14 +119,14 @@ display_names:
114119
pytorch-training: "PyTorch Training"
115120
# ...
116121
117-
# Framework groups for support policy consolidation
122+
# Framework groups for support policy consolidation (lowercase keys)
118123
framework_groups:
119-
PyTorch:
124+
pytorch:
120125
- pytorch-training
121126
- pytorch-inference
122127
- pytorch-training-arm64
123128
- pytorch-inference-arm64
124-
TensorFlow:
129+
tensorflow:
125130
- tensorflow-training
126131
- tensorflow-inference
127132
- tensorflow-inference-arm64
@@ -204,7 +209,7 @@ PyTorch:
204209
#### Adding Legacy Entries
205210

206211
1. Open `docs/src/legacy/legacy_support.yml`
207-
1. Add entries under the framework name key (must match `framework_groups` keys exactly)
212+
1. Add entries under the framework name key (must match `display_names` keys for framework groups, e.g., `pytorch`, `tensorflow`)
208213
1. Each entry needs: `version`, `ga`, `eop`
209214

210215
#### Behavior

docs/DEVELOPMENT.md

Lines changed: 70 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,21 @@ docs/
1313
│ │ │ └── 2.9-cpu-sagemaker.yml
1414
│ │ └── <repository>/
1515
│ │ └── <version>-<accelerator>-<platform>.yml
16+
│ ├── legacy/ # Historical support data
17+
│ │ └── legacy_support.yml
1618
│ ├── tables/ # Table column configurations
1719
│ │ └── <repository>.yml
1820
│ ├── templates/reference/ # Jinja2 templates
1921
│ │ ├── available_images.template.md
2022
│ │ └── support_policy.template.md
21-
│ ├── global.yml # Shared terminology and configuration
23+
│ ├── constants.py # Path constants and global variables
2224
│ ├── generate.py # Generation logic
23-
│ └── main.py # CLI entry point
25+
│ ├── global.yml # Shared terminology and configuration
26+
│ ├── hooks.py # MkDocs hooks entry point
27+
│ ├── logger.py # Logging configuration
28+
│ ├── macros.py # MkDocs macros plugin integration
29+
│ ├── main.py # CLI entry point
30+
│ └── utils.py # Reusable helper functions
2431
├── reference/
2532
│ ├── available_images.md # Generated
2633
│ └── support_policy.md # Generated
@@ -111,6 +118,66 @@ eop: '2026-10-15' # End of Patch date (YYYY-MM-DD)
111118
- The generator validates this and raises an error if dates are inconsistent
112119
- Supported vs Unsupported is auto-determined by comparing EOP to current date
113120
121+
### Support Policy Consolidation
122+
123+
The `framework_groups` configuration in `global.yml` consolidates support policy rows by framework. Repositories in the same group are combined into a
124+
single row using the framework display name.
125+
126+
```yaml
127+
# docs/src/global.yml
128+
framework_groups:
129+
pytorch:
130+
- pytorch-training
131+
- pytorch-inference
132+
- pytorch-training-arm64
133+
- pytorch-inference-arm64
134+
tensorflow:
135+
- tensorflow-training
136+
- tensorflow-inference
137+
- tensorflow-inference-arm64
138+
```
139+
140+
**Requirements:**
141+
142+
- All repositories in a group with a given version must have identical GA/EOP dates
143+
- Missing versions in some repositories are allowed (only present repos are consolidated)
144+
- A `ValueError` is raised if dates differ within a group for the same version
145+
146+
* * *
147+
148+
## Legacy Support Data
149+
150+
Historical support policy data for older, unsupported images is stored in `docs/src/legacy/legacy_support.yml`. This data appears only in the "No
151+
Longer Supported" section of `support_policy.md`.
152+
153+
### File Format
154+
155+
```yaml
156+
PyTorch:
157+
- version: "2.5"
158+
ga: "2024-10-29"
159+
eop: "2025-10-29"
160+
- version: "2.4"
161+
ga: "2024-07-24"
162+
eop: "2025-07-24"
163+
TensorFlow:
164+
- version: "2.16"
165+
ga: "2024-03-15"
166+
eop: "2025-03-15"
167+
```
168+
169+
### Adding Legacy Entries
170+
171+
1. Open `docs/src/legacy/legacy_support.yml`
172+
2. Add entries under the framework display name key (e.g., `PyTorch`, `TensorFlow`)
173+
3. Each entry requires: `version`, `ga`, `eop`
174+
175+
### Behavior
176+
177+
- Legacy entries appear only in `support_policy.md` (unsupported section)
178+
- Images past their EOP date are automatically filtered from `available_images.md`
179+
- The `is_image_supported()` function checks if `eop >= today`
180+
114181
* * *
115182

116183
## Editing Table Columns in available_images.md
@@ -317,7 +384,7 @@ python main.py --verbose
317384
### Preview with MkDocs
318385

319386
```bash
320-
cd /path/to/deep-learning-containers
387+
cd docs
321388
mkdocs serve
322389
```
323390

0 commit comments

Comments
 (0)