Skip to content

Commit d702fd6

Browse files
committed
feat: Enhance DAG documentation for tpu-info CLI tool validation
1 parent 3d7eacb commit d702fd6

1 file changed

Lines changed: 15 additions & 6 deletions

File tree

dags/tpu_observability/tpu_info_help_validation_dags.py

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,8 @@
1313
# limitations under the License.
1414

1515
"""
16-
A DAG to validate the `tpu-info -help` command execution inside TPU worker pods.
16+
A DAG to validate the `tpu-info` CLI tool, ensuring help documentation,
17+
version metadata, and process monitoring are functional inside TPU worker pods.
1718
"""
1819

1920
import datetime
@@ -168,14 +169,22 @@ def validate_tpu_info_process(info: node_pool.Info, pod_name: str) -> str:
168169
"v6e-16",
169170
],
170171
description=(
171-
"This DAG validates the `tpu-info -help` command "
172-
"execution inside TPU worker pods "
172+
"Validates tpu-info CLI tool: help documentation, version metadata, "
173+
"and process monitoring capabilities inside TPU worker pods."
173174
),
174175
doc_md="""
175176
### Description
176-
This DAG validates the `tpu-info -help` command execution inside TPU worker pods
177-
across different TPU versions and machine configurations.
178-
It ensures that the command runs successfully and returns the expected help information.
177+
This DAG performs an end-to-end validation of the `tpu-info` observability tool
178+
within TPU worker pods. It ensures the CLI tool is correctly installed and
179+
functional across different TPU configurations.
180+
181+
### Validation Steps:
182+
1. **Help Menu Validation**: Verifies `tpu-info -help` displays all required
183+
options (streaming, rate, etc.) and specific usage instructions.
184+
2. **Process Table Validation**: Confirms `tpu-info --process` can successfully
185+
map PIDs to TPU chips.
186+
3. **Version Validation**: Ensures `tpu-info --version` correctly reports
187+
the tool version, libtpu version, and accelerator type.
179188
""",
180189
) as dag:
181190
for machine in MachineConfigMap:

0 commit comments

Comments
 (0)