Skip to content

[None][feat] Add AD model list validation checks to pre-commit and PR…#12036

Merged
tcherckez-nvidia merged 1 commit intoNVIDIA:mainfrom
tcherckez-nvidia:add-model-list-validation
Mar 9, 2026
Merged

[None][feat] Add AD model list validation checks to pre-commit and PR…#12036
tcherckez-nvidia merged 1 commit intoNVIDIA:mainfrom
tcherckez-nvidia:add-model-list-validation

Conversation

@tcherckez-nvidia
Copy link
Collaborator

@tcherckez-nvidia tcherckez-nvidia commented Mar 9, 2026

… check

Summary by CodeRabbit

  • Chores
    • Added automated validation for model registry entries to ensure data quality and consistency across deployments.

Description

Test Coverage

PR Checklist

Please review the following before submitting your PR:

  • PR description clearly explains what and why. If using CodeRabbit's summary, please make sure it makes sense.

  • PR Follows TRT-LLM CODING GUIDELINES to the best of your knowledge.

  • Test cases are provided for new code paths (see test instructions)

  • Any new dependencies have been scanned for license and vulnerabilities

  • CODEOWNERS updated if ownership changes

  • Documentation updated as needed

  • Update tava architecture diagram if there is a significant design change in PR.

  • The reviewers assigned automatically/manually are appropriate for the PR.

  • Please check this after reviewing the above items as appropriate for this PR.

GitHub Bot Help

To see a list of available CI bot commands, please comment /bot help.

… check

Signed-off-by: Tal Cherckez <127761168+tcherckez-nvidia@users.noreply.github.com>
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 9, 2026

📝 Walkthrough

Walkthrough

This PR adds validation for an AutoDeploy model registry by introducing a GitHub Actions workflow and pre-commit hook that both execute a new Python script to validate the YAML model registry file structure and content.

Changes

Cohort / File(s) Summary
CI/CD and Pre-commit Integration
.github/workflows/model-registry-check.yml, .pre-commit-config.yaml
Added GitHub Actions workflow that triggers on pull request events for model registry changes, and configured corresponding pre-commit hook to validate the model registry YAML file using PyYAML.
Model Registry Validation Script
scripts/check_model_registry.py
Implements validation logic that loads the model registry YAML, enforces required keys (name, yaml_extra) for each model entry, validates data types and non-empty constraints, detects duplicate model names, and reports structured error messages with detailed per-entry validation failures.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~13 minutes

🚥 Pre-merge checks | ❌ 3

❌ Failed checks (2 warnings, 1 inconclusive)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
Description check ⚠️ Warning The PR description is largely incomplete. Only the template structure is present with most required sections empty (Description and Test Coverage are blank), and the checklist lacks substantive content. Fill in the Description section explaining what the validation checks do and why they are needed. Complete the Test Coverage section listing relevant tests. Provide a meaningful PR title following the template format [JIRA/GitHub issue][type] Summary.
Title check ❓ Inconclusive The title is incomplete and appears truncated, ending with 'PR…' which suggests the full title was cut off and cannot be properly evaluated. Complete the pull request title. It should follow the format '[ticket][type] Summary' with a clear, concise description of the main change.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🧹 Nitpick comments (1)
.github/workflows/model-registry-check.yml (1)

18-22: Consider removing the edited trigger type.

The edited event fires when the PR title or description is changed, not when code changes. This will cause unnecessary workflow runs. For code validation, opened, synchronize, and reopened are sufficient.

♻️ Suggested fix
 on:
   pull_request:
-    types: [opened, edited, synchronize, reopened]
+    types: [opened, synchronize, reopened]
     paths:
       - examples/auto_deploy/model_registry/models.yaml
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In @.github/workflows/model-registry-check.yml around lines 18 - 22, Remove the
unnecessary "edited" pull_request trigger from the types array in the
model-registry-check workflow so the job only runs on PR code changes; update
the types list to ["opened", "synchronize", "reopened"] in the on: pull_request
configuration (remove "edited" from the array in the existing YAML block).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In @.github/workflows/model-registry-check.yml:
- Around line 18-22: Remove the unnecessary "edited" pull_request trigger from
the types array in the model-registry-check workflow so the job only runs on PR
code changes; update the types list to ["opened", "synchronize", "reopened"] in
the on: pull_request configuration (remove "edited" from the array in the
existing YAML block).

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 20170758-73ca-4bba-9cf0-263c70652b62

📥 Commits

Reviewing files that changed from the base of the PR and between 34a9153 and d8e6701.

📒 Files selected for processing (3)
  • .github/workflows/model-registry-check.yml
  • .pre-commit-config.yaml
  • scripts/check_model_registry.py

Copy link
Collaborator

@dpitman-nvda dpitman-nvda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tcherckez-nvidia
Copy link
Collaborator Author

/bot help

@github-actions
Copy link

github-actions bot commented Mar 9, 2026

GitHub Bot Help

/bot [-h] ['run', 'kill', 'skip', 'reuse-pipeline'] ...

Provide a user friendly way for developers to interact with a Jenkins server.

Run /bot [-h|--help] to print this help message.

See details below for each supported subcommand.

Details

run [--reuse-test (optional)pipeline-id --disable-fail-fast --skip-test --stage-list "A10-PyTorch-1, xxx" --gpu-type "A30, H100_PCIe" --test-backend "pytorch, cpp" --add-multi-gpu-test --only-multi-gpu-test --disable-multi-gpu-test --post-merge --extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx" --detailed-log --debug(experimental) --high-priority]

Launch build/test pipelines. All previously running jobs will be killed.

--reuse-test (optional)pipeline-id (OPTIONAL) : Allow the new pipeline to reuse build artifacts and skip successful test stages from a specified pipeline or the last pipeline if no pipeline-id is indicated. If the Git commit ID has changed, this option will be always ignored. The DEFAULT behavior of the bot is to reuse build artifacts and successful test results from the last pipeline.

--disable-reuse-test (OPTIONAL) : Explicitly prevent the pipeline from reusing build artifacts and skipping successful test stages from a previous pipeline. Ensure that all builds and tests are run regardless of previous successes.

--disable-fail-fast (OPTIONAL) : Disable fail fast on build/tests/infra failures.

--skip-test (OPTIONAL) : Skip all test stages, but still run build stages, package stages and sanity check stages. Note: Does NOT update GitHub check status.

--stage-list "A10-PyTorch-1, xxx" (OPTIONAL) : Only run the specified test stages. Examples: "A10-PyTorch-1, xxx". Note: Does NOT update GitHub check status.

--gpu-type "A30, H100_PCIe" (OPTIONAL) : Only run the test stages on the specified GPU types. Examples: "A30, H100_PCIe". Note: Does NOT update GitHub check status.

--test-backend "pytorch, cpp" (OPTIONAL) : Skip test stages which don't match the specified backends. Only support [pytorch, cpp, tensorrt, triton]. Examples: "pytorch, cpp" (does not run test stages with tensorrt or triton backend). Note: Does NOT update GitHub pipeline status.

--only-multi-gpu-test (OPTIONAL) : Only run the multi-GPU tests. Note: Does NOT update GitHub check status.

--disable-multi-gpu-test (OPTIONAL) : Disable the multi-GPU tests. Note: Does NOT update GitHub check status.

--add-multi-gpu-test (OPTIONAL) : Force run the multi-GPU tests in addition to running L0 pre-merge pipeline.

--post-merge (OPTIONAL) : Run the L0 post-merge pipeline instead of the ordinary L0 pre-merge pipeline.

--extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx" (OPTIONAL) : Run the ordinary L0 pre-merge pipeline and specified test stages. Examples: --extra-stage "H100_PCIe-TensorRT-Post-Merge-1, xxx".

--detailed-log (OPTIONAL) : Enable flushing out all logs to the Jenkins console. This will significantly increase the log volume and may slow down the job.

--debug (OPTIONAL) : Experimental feature. Enable access to the CI container for debugging purpose. Note: Specify exactly one stage in the stage-list parameter to access the appropriate container environment. Note: Does NOT update GitHub check status.

--high-priority (OPTIONAL) : Run the pipeline with high priority. This option is restricted to authorized users only and will route the job to a high-priority queue.

kill

kill

Kill all running builds associated with pull request.

skip

skip --comment COMMENT

Skip testing for latest commit on pull request. --comment "Reason for skipping build/test" is required. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break.

reuse-pipeline

reuse-pipeline

Reuse a previous pipeline to validate current commit. This action will also kill all currently running builds associated with the pull request. IMPORTANT NOTE: This is dangerous since lack of user care and validation can cause top of tree to break.

@tcherckez-nvidia
Copy link
Collaborator Author

/bot skip --comment "Adding PR and pre-commit check to model list, not related to functionality"

@tcherckez-nvidia tcherckez-nvidia enabled auto-merge (squash) March 9, 2026 18:43
@tensorrt-cicd
Copy link
Collaborator

PR_Github #38315 [ skip ] triggered by Bot. Commit: d8e6701 Link to invocation

@tensorrt-cicd
Copy link
Collaborator

PR_Github #38315 [ skip ] completed with state SUCCESS. Commit: d8e6701
Skipping testing for commit d8e6701

Link to invocation

@tcherckez-nvidia tcherckez-nvidia merged commit 35ccedd into NVIDIA:main Mar 9, 2026
7 checks passed
@tcherckez-nvidia tcherckez-nvidia deleted the add-model-list-validation branch March 17, 2026 07:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants