Skip to content

[OMNIML-3779] Add recipe into CLAUDE.md#1106

Open
shengliangxu wants to merge 1 commit intomainfrom
shengliangx/claude-recipe-lib
Open

[OMNIML-3779] Add recipe into CLAUDE.md#1106
shengliangxu wants to merge 1 commit intomainfrom
shengliangx/claude-recipe-lib

Conversation

@shengliangxu
Copy link
Contributor

@shengliangxu shengliangxu commented Mar 24, 2026

What does this PR do?

Add recipe into CLAUDE.md

Summary by CodeRabbit

  • Documentation
    • Updated internal codebase documentation to reflect the addition of a new recipe namespace for optimization specifications. Expanded architectural overview to include recipe loading and validation capabilities, along with reference materials for recipe-based model optimization workflows.

Signed-off-by: Shengliang Xu <shengliangx@nvidia.com>
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Mar 24, 2026

📝 Walkthrough

Walkthrough

Updated CLAUDE.md documentation to reflect the addition of a new modelopt.recipe namespace for recipe loading, parsing, and validation. Added a "Core Abstraction: Recipes" section describing recipes as declarative YAML-based optimization specifications and documented built-in recipe assets.

Changes

Cohort / File(s) Summary
Documentation Update
CLAUDE.md
Updated to describe four top-level namespaces (added modelopt.recipe), introduced "Core Abstraction: Recipes" section defining YAML-based declarative specs, extended Key Files table with recipe-related modules (modelopt/recipe/loader.py, modelopt/recipe/config.py), and added declarative recipes to design patterns.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 4
✅ Passed checks (4 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Security Anti-Patterns ✅ Passed PR contains only documentation changes to CLAUDE.md with no Python code modifications, dependencies changes, or security-sensitive patterns.
Title check ✅ Passed The title directly matches the changeset content—it describes the addition of recipe information to CLAUDE.md, which is exactly what the pull request does.

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

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch shengliangx/claude-recipe-lib

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

@github-actions
Copy link
Contributor

PR Preview Action v1.8.1

QR code for preview link

🚀 View preview at
https://NVIDIA.github.io/Model-Optimizer/pr-preview/pr-1106/

Built to branch gh-pages at 2026-03-24 00:21 UTC.
Preview will be ready when the GitHub Pages deployment is complete.

@shengliangxu shengliangxu changed the title Add recipe into CLAUDE.md [OMNIML-3779] Add recipe into CLAUDE.md Mar 24, 2026
@codecov
Copy link

codecov bot commented Mar 24, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 70.23%. Comparing base (c425524) to head (4d2b04a).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1106   +/-   ##
=======================================
  Coverage   70.23%   70.23%           
=======================================
  Files         227      227           
  Lines       25909    25909           
=======================================
  Hits        18198    18198           
  Misses       7711     7711           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

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.

2 participants