Skip to content

skills/cuopt-routing-api-python: update with benchmark details - #1333

Merged
ramakrishnap-nv merged 2 commits into
mainfrom
skills-cuopt-routing-api-python
May 29, 2026
Merged

skills/cuopt-routing-api-python: update with benchmark details#1333
ramakrishnap-nv merged 2 commits into
mainfrom
skills-cuopt-routing-api-python

Conversation

@ramakrishnap-nv

Copy link
Copy Markdown
Collaborator

update with benchmark details

@copy-pr-bot

copy-pr-bot Bot commented May 29, 2026

Copy link
Copy Markdown

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

Signed-off-by: Ramakrishna Prabhu <ramakrishnap@nvidia.com>
@ramakrishnap-nv
ramakrishnap-nv force-pushed the skills-cuopt-routing-api-python branch from e2998a1 to 2c0c193 Compare May 29, 2026 01:17
@ramakrishnap-nv
ramakrishnap-nv marked this pull request as ready for review May 29, 2026 01:17
@ramakrishnap-nv
ramakrishnap-nv requested a review from a team as a code owner May 29, 2026 01:17
@ramakrishnap-nv
ramakrishnap-nv requested a review from Iroy30 May 29, 2026 01:17
@ramakrishnap-nv

Copy link
Copy Markdown
Collaborator Author

/nvskills-ci

@ramakrishnap-nv ramakrishnap-nv self-assigned this May 29, 2026
@ramakrishnap-nv ramakrishnap-nv added non-breaking Introduces a non-breaking change improvement Improves an existing functionality labels May 29, 2026
@coderabbitai

coderabbitai Bot commented May 29, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Updates the cuopt-routing-api-python skill: reformats skill-card metadata, adds a BENCHMARK.md evaluation report (VERDICT: FAIL), inserts a blank line in SKILL.md frontmatter, and regenerates the Sigstore DSSE signature bundle reflecting new digests.

Changes

cuopt-routing-api-python documentation & attestation

Layer / File(s) Summary
Skill card metadata and references
skills/cuopt-routing-api-python/skill-card.md
Updated Owner/License/Use Case frontmatter, expanded/reordered References, and normalized Skill Output and evaluation-result formatting.
SKILL frontmatter spacing
skills/cuopt-routing-api-python/SKILL.md
Inserted a blank line between YAML frontmatter and the "cuOpt Routing — Python API" section header.
NVSkills-Eval benchmark report
skills/cuopt-routing-api-python/BENCHMARK.md
Added a 3-tier evaluation report (VERDICT: FAIL) with agents, dimensions, dataset composition, per-dimension scores, Tier1 static findings, Tier2 deduplication findings, and a publication recommendation.
Sigstore DSSE bundle
skills/cuopt-routing-api-python/skill.oms.sig
Replaced the DSSE bundle line with updated payload/resource digests and a new signatures[0].sig value reflecting the documentation changes.

🎯 3 (Moderate) | ⏱️ ~20 minutes

  • NVIDIA/cuopt#1287: Overlaps on skills/cuopt-routing-api-python metadata and signature handling; related to validation/signature compliance work.
  • NVIDIA/cuopt#1308: Related changes to the skill attestation bundle and evaluations for the routing skill.
  • NVIDIA/cuopt#1301: Touches the same routing skill documentation artifacts (skill-card.md, SKILL.md) and references reorganization.

Suggested reviewers:

  • Iroy30
  • tmckayus
🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description is extremely vague and generic, using only 'update with benchmark details' without meaningful context about what was added or changed. Expand the description to explain the benchmark evaluation results, the changes made to documentation, and the reasoning behind the updates.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main change—updating the cuopt-routing-api-python skill with benchmark details, which is reflected in the BENCHMARK.md addition and related updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

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

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch skills-cuopt-routing-api-python

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

Signed-off-by: nvskills-svc-account <svc-nvskills-signing@nvidia.com>
@copy-pr-bot

copy-pr-bot Bot commented May 29, 2026

Copy link
Copy Markdown

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@skills/cuopt-routing-api-python/BENCHMARK.md`:
- Line 72: Update the truncated security finding text in BENCHMARK.md by
replacing the truncated word "reac" with the full word "reach" in the MEDIUM
SECURITY/Unknown (SQP-2) entry so the sentence reads "...making it accessible to
any host that can reach (references/server_examples.md:7)". Ensure no other
words were accidentally altered and run a quick spellcheck on that line.

In `@skills/cuopt-routing-api-python/skill-card.md`:
- Around line 63-70: Add a single blank line after the evaluation results
Markdown table (the table starting with "| Dimension | Num | `claude-code` |
`codex` |") so there is an empty line separating the table from the following
section heading; update the skill-card.md content immediately after that table
to insert one newline before the next heading or paragraph.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 358fec5a-5730-495f-a4fc-cc410a6e4c7d

📥 Commits

Reviewing files that changed from the base of the PR and between 2c0c193 and cc31038.

📒 Files selected for processing (3)
  • skills/cuopt-routing-api-python/BENCHMARK.md
  • skills/cuopt-routing-api-python/skill-card.md
  • skills/cuopt-routing-api-python/skill.oms.sig

Top findings:

- MEDIUM SCHEMA/body_recommended_section: Missing recommended section: '## Instructions' (`skills/cuopt-routing-api-python/SKILL.md`)
- MEDIUM SECURITY/Unknown (SQP-2): Binding the cuOpt server to 0.0.0.0 exposes it on all network interfaces, making it accessible to any host that can reac (`references/server_examples.md:7`)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Fix truncated text.

The finding description is cut off mid-word. "reac" should be "reach".

✏️ Proposed fix
-- MEDIUM SECURITY/Unknown (SQP-2): Binding the cuOpt server to 0.0.0.0 exposes it on all network interfaces, making it accessible to any host that can reac (`references/server_examples.md:7`)
+- MEDIUM SECURITY/Unknown (SQP-2): Binding the cuOpt server to 0.0.0.0 exposes it on all network interfaces, making it accessible to any host that can reach (`references/server_examples.md:7`)
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- MEDIUM SECURITY/Unknown (SQP-2): Binding the cuOpt server to 0.0.0.0 exposes it on all network interfaces, making it accessible to any host that can reac (`references/server_examples.md:7`)
- MEDIUM SECURITY/Unknown (SQP-2): Binding the cuOpt server to 0.0.0.0 exposes it on all network interfaces, making it accessible to any host that can reach (`references/server_examples.md:7`)
🧰 Tools
🪛 LanguageTool

[grammar] ~72-~72: Ensure spelling is correct
Context: ...king it accessible to any host that can reac (references/server_examples.md:7) - L...

(QB_NEW_EN_ORTHOGRAPHY_ERROR_IDS_1)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@skills/cuopt-routing-api-python/BENCHMARK.md` at line 72, Update the
truncated security finding text in BENCHMARK.md by replacing the truncated word
"reac" with the full word "reach" in the MEDIUM SECURITY/Unknown (SQP-2) entry
so the sentence reads "...making it accessible to any host that can reach
(references/server_examples.md:7)". Ensure no other words were accidentally
altered and run a quick spellcheck on that line.

Comment on lines +63 to +70
| Dimension | Num | `claude-code` | `codex` |
|---|---:|---:|---:|
| Security | 2 | 100% (+0%) | 100% (+0%) |
| Correctness | 2 | 100% (+0%) | 95% (+3%) |
| Discoverability | 2 | 100% (+0%) | 70% (-5%) |
| Effectiveness | 2 | 83% (+14%) | 83% (+12%) |
| Efficiency | 2 | 93% (-0%) | 56% (-5%) |

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Add blank line after the table.

The evaluation results table should be followed by a blank line before the next section heading to comply with Markdown formatting standards.

📝 Proposed fix
 | Effectiveness | 2 | 83% (+14%) | 83% (+12%) |
 | Efficiency | 2 | 93% (-0%) | 56% (-5%) |
+
 ## Skill Version(s): <br>
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
| Dimension | Num | `claude-code` | `codex` |
|---|---:|---:|---:|
| Security | 2 | 100% (+0%) | 100% (+0%) |
| Correctness | 2 | 100% (+0%) | 95% (+3%) |
| Discoverability | 2 | 100% (+0%) | 70% (-5%) |
| Effectiveness | 2 | 83% (+14%) | 83% (+12%) |
| Efficiency | 2 | 93% (-0%) | 56% (-5%) |
| Dimension | Num | `claude-code` | `codex` |
|---|---:|---:|---:|
| Security | 2 | 100% (+0%) | 100% (+0%) |
| Correctness | 2 | 100% (+0%) | 95% (+3%) |
| Discoverability | 2 | 100% (+0%) | 70% (-5%) |
| Effectiveness | 2 | 83% (+14%) | 83% (+12%) |
| Efficiency | 2 | 93% (-0%) | 56% (-5%) |
🧰 Tools
🪛 markdownlint-cli2 (0.22.1)

[warning] 63-63: Tables should be surrounded by blank lines

(MD058, blanks-around-tables)

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@skills/cuopt-routing-api-python/skill-card.md` around lines 63 - 70, Add a
single blank line after the evaluation results Markdown table (the table
starting with "| Dimension | Num | `claude-code` | `codex` |") so there is an
empty line separating the table from the following section heading; update the
skill-card.md content immediately after that table to insert one newline before
the next heading or paragraph.

@ramakrishnap-nv
ramakrishnap-nv merged commit c4582c4 into main May 29, 2026
4 checks passed
@ramakrishnap-nv
ramakrishnap-nv deleted the skills-cuopt-routing-api-python branch July 9, 2026 18:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

improvement Improves an existing functionality non-breaking Introduces a non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants