docs: add adaptive tuning skills#138
Conversation
Signed-off-by: mnajafian-nv <mnajafian@nvidia.com>
mnajafian-nv
added
Improvement
github-actions
Bot
added
size:L
WalkthroughThis PR refactors adaptive optimization documentation and skills to use "adaptive tuning" terminology, introduces three new skill specifications for configurable tuning workflows, and deprecates legacy optimizer-specific skill surfaces in favor of generic adaptive plugin interfaces. ChangesAdaptive Tuning Documentation and Skill Reorganization
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Signed-off-by: mnajafian-nv <mnajafian@nvidia.com>
Signed-off-by: mnajafian-nv <mnajafian@nvidia.com>
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
skills/nemo-flow-tune-performance/SKILL.md (1)
22-32: 🧹 Nitpick | 🔵 Trivial | 💤 Low valueConsider updating legacy "optimizer" terminology in negative example.
Line 27 uses "separate optimizer object" in a negative example. While this tells users what NOT to do, it still references the legacy optimizer terminology that this PR is moving away from.
♻️ Suggested terminology update
-- Use the adaptive plugin component rather than inventing a separate optimizer - object or hand-registering adaptive behavior at every call site. +- Use the adaptive plugin component rather than inventing separate tuning + logic or hand-registering adaptive behavior at every call site.🤖 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/nemo-flow-tune-performance/SKILL.md` around lines 22 - 32, Update the legacy "optimizer" terminology used in the negative example under "Default Guidance": replace the phrase "separate optimizer object" with a modern term such as "separate adaptive controller" or "separate tuning component" so the guidance avoids legacy wording; specifically edit the bullet that reads "Use the adaptive plugin component rather than inventing a separate optimizer object or hand-registering adaptive behavior at every call site" to use the chosen replacement while preserving the intent of discouraging ad-hoc, hand-registered adaptive behavior.
🤖 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 `@docs/integrations/about.md`:
- Line 14: Rename the "Optimization" wording to "Tuning" in
docs/integrations/about.md: change the sentence fragment "optimization features"
to "tuning features" (or similar) and update the support-matrix column header
text "Optimization" to "Tuning" so the document matches the Adaptive plugin's
use of "tune"/"tuning" (search for the exact strings "optimization features" and
the column header "Optimization" to locate where to edit).
---
Outside diff comments:
In `@skills/nemo-flow-tune-performance/SKILL.md`:
- Around line 22-32: Update the legacy "optimizer" terminology used in the
negative example under "Default Guidance": replace the phrase "separate
optimizer object" with a modern term such as "separate adaptive controller" or
"separate tuning component" so the guidance avoids legacy wording; specifically
edit the bullet that reads "Use the adaptive plugin component rather than
inventing a separate optimizer object or hand-registering adaptive behavior at
every call site" to use the chosen replacement while preserving the intent of
discouraging ad-hoc, hand-registered adaptive behavior.
🪄 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: ASSERTIVE
Plan: Enterprise
Run ID: a695f205-3c21-4ce3-b3b5-54ab6db8a7bf
📒 Files selected for processing (6)
docs/integrations/about.mddocs/plugins/adaptive/about.mdskills/nemo-flow-configure-optimizer/SKILL.mdskills/nemo-flow-start-optimizer/SKILL.mdskills/nemo-flow-tune-performance/SKILL.mdskills/nemo-flow-use-optimizer-hints/SKILL.md
💤 Files with no reviewable changes (4)
- docs/plugins/adaptive/about.md
- skills/nemo-flow-configure-optimizer/SKILL.md
- skills/nemo-flow-start-optimizer/SKILL.md
- skills/nemo-flow-use-optimizer-hints/SKILL.md
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: Documentation / Build
🧰 Additional context used
📓 Path-based instructions (21)
**/*.{md,rst,html,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
**/*.{md,rst,html,txt}: Always spellNVIDIAin all caps. Do not useNvidia,nvidia,nVidia,nVIDIA, orNV.
Usean NVIDIAbefore a noun because the name starts with an 'en' sound.
Do not add a registered trademark symbol afterNVIDIAwhen referring to the company.
Use trademark symbols with product names only when the document type or legal guidance requires them.
Verify official capitalization, spacing, and hyphenation for product names.
Precede NVIDIA product names withNVIDIAon first mention when it is natural and accurate.
Do not rewrite product names for grammar or title-case rules.
Preserve third-party product names according to the owner's spelling.
Include the company name and full model qualifier on first use when it helps identify the model.
Preserve the official capitalization and punctuation of model names.
Use shorter family names only after the full name is established.
Spell out a term on first use and put the acronym in parentheses unless the acronym is widely understood by the intended audience.
Use the acronym on later mentions after it has been defined.
For long documents, reintroduce the full term if readers might lose context.
Form plurals of acronyms withs, not an apostrophe, such asGPUs.
In headings, common acronyms can remain abbreviated. Spell out the term in the first or second sentence of the body.
Common terms such asCPU,GPU,PC,API, andUIusually do not need to be spelled out for developer audiences.
Files:
docs/integrations/about.mdskills/nemo-flow-tune-performance/SKILL.md
**/*.{md,rst,html}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-brand-terminology.md)
Link the first mention of a product name when the destination helps the reader.
Files:
docs/integrations/about.mdskills/nemo-flow-tune-performance/SKILL.md
**/*.{md,rst,txt}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-guide.md)
**/*.{md,rst,txt}: SpellNVIDIAin all caps. Do not useNvidia,nvidia, orNV.
Format commands, code elements, expressions, package names, file names, and paths as inline code.
Use descriptive link text. Avoid raw URLs and weak anchors such as 'here' or 'read more.'
Use title case consistently for technical documentation headings.
Introduce code blocks, lists, tables, and images with complete sentences.
Write procedures as imperative steps. Keep steps parallel and split long procedures into smaller tasks.
Prefer active voice, present tense, short sentences, contractions, and plain English.
Usecanfor possibility and reservemayfor permission.
Useafterfor temporal relationships instead ofonce.
Preferrefer tooverseewhen the wording points readers to another resource.
Avoid culture-specific idioms, unnecessary Latinisms, jokes, and marketing exaggeration in technical documentation.
Spell out months in body text, avoid ordinal dates, and use clear time zones.
Spell out whole numbers from zero through nine unless they are technical values, parameters, versions, or UI values.
Use numerals for 10 or greater and include commas in thousands.
Do not add trademark symbols to learning-oriented documentation unless the source, platform, or legal guidance explicitly requires them.
Do not add trademark symbols to NeMo Flow learning documentation by default.
Do not rewrite API names, package names, command flags, or code literals for style reasons.
Files:
docs/integrations/about.mdskills/nemo-flow-tune-performance/SKILL.md
**/*.{md,markdown,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/assets/nvidia-style-technical-docs.md)
**/*.{md,markdown,rst}: Use title case consistently in technical documentation headings
Avoid quotation marks, ampersands, and exclamation marks in headings
Keep product, event, research, and whitepaper names in their official title case
Use title case for table headers
Do not force social-media sentence case into technical docs
Use monospace formatting for code elements, commands, parameters, package names, and expressions
Use monospace formatting for directories, file names, and paths
Use angle brackets inside monospace for variables inside paths, such as/home/<username>/.login
Use quotation marks for error messages and strings in documentation
Use bold formatting for UI buttons, menus, fields, and labels in documentation
Use angle brackets between UI labels for menu paths, such as File > Save As
Use italics for new terms on first use in documentation
Use italics for publication titles in documentation
Use plain text formatting for keyboard shortcuts in documentation
Prefer[NVIDIA/NeMo](link)format for GitHub repository references over generic phrases like 'the GitHub repo'
Introduce every code block with a complete sentence
Do not make a code block complete the grammar of the previous sentence
Do not continue a sentence after a code block
Use syntax highlighting when the format supports it for code blocks
Avoid the word 'snippet' unless the surrounding docs already use it as a term of art
Keep inline method, function, and class references consistent with nearby docs, omitting empty parentheses for prose readability when no call is shown
Use descriptive anchor text that matches the destination title when possible for links
Avoid raw URLs in running text in documentation
Avoid generic link anchors such as 'here,' 'this page,' and 'read more' in documentation
Include the acronym in link text if a linked term includes an acronym
Do not link long sentences or multiple sentences in documentation
Avoid links that pull readers away from a procedure unles...
Files:
docs/integrations/about.mdskills/nemo-flow-tune-performance/SKILL.md
**/*.{html,md}
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Include SPDX license headers in HTML and Markdown files using HTML comment syntax
Files:
docs/integrations/about.mdskills/nemo-flow-tune-performance/SKILL.md
docs/**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Run
./scripts/build-docs.shfor documentation site changes
docs/**/*.md: Relevant getting-started or reference docs must be updated when examples change
Release-policy docs must point to GitHub Releases as the only release-history source of truth
docs/**/*.md: Use title case for headings in technical documentation
Introduce code blocks, tables, and lists with complete lead-in sentences in documentation
Files:
docs/integrations/about.md
**/*.md
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Run Markdown link checking via
lycheeforREADME.md,CONTRIBUTING.md, anddocs/through pre-commit hooks
Files:
docs/integrations/about.mdskills/nemo-flow-tune-performance/SKILL.md
**/*.{md,markdown,py,sh,bash,js,ts,java,cpp,go,rust}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep package names, repo references, and build commands current in documentation
Files:
docs/integrations/about.mdskills/nemo-flow-tune-performance/SKILL.md
{RELEASING.md,CHANGELOG.md,docs/**/*.md}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep release-process and release-notes guidance in repo-maintainer docs such as RELEASING.md, not as user-facing docs pages or CHANGELOG.md
Files:
docs/integrations/about.md
**/*.{md,markdown,py,sh,bash}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Keep stable user-facing wrappers at scripts/ root in docs and examples; only point at namespaced helper paths when documenting internal maintenance work
Files:
docs/integrations/about.mdskills/nemo-flow-tune-performance/SKILL.md
**/*.{md,markdown,py,sh,bash,js,ts,example}
📄 CodeRabbit inference engine (.agents/skills/contribute-docs/SKILL.md)
Example commands must match current package names and paths
Files:
docs/integrations/about.mdskills/nemo-flow-tune-performance/SKILL.md
**/{integrations,integration,*-integration}/**
📄 CodeRabbit inference engine (.agents/skills/contribute-integration/SKILL.md)
**/{integrations,integration,*-integration}/**: Keep NeMo Flow optional in framework integrations
Preserve the framework's original behavior when NeMo Flow is absent
Wrap tool and LLM paths at the correct framework boundary
Integration pattern must followdocs/integrate-frameworks/adding-scopes.md
Files:
docs/integrations/about.md
{scripts/*.sh,docs/**/*.md}
📄 CodeRabbit inference engine (.agents/skills/contribute-integration/SKILL.md)
Use root
./scripts/*.shcommands in docs and contributor guidance as documented, with implementations underscripts/third-party/
Files:
docs/integrations/about.md
{README*,CHANGELOG*,docs/**/*.{md,rst,txt},examples/**/*,*.md}
📄 CodeRabbit inference engine (.agents/skills/rename-surfaces/SKILL.md)
Update documentation, examples, and getting-started guides with new package/module/crate names after rename operations
Files:
docs/integrations/about.md
**/*.{md,txt,rst}
📄 CodeRabbit inference engine (.agents/skills/review-doc-style/SKILL.md)
**/*.{md,txt,rst}: Ensure commands, package names, file paths, and APIs in documentation are correct and not stale; flag incorrect or outdated information as blocking issues
Ensure examples and procedures in documentation will execute successfully with current APIs and commands
Use consistent user-facing terminology throughout documentation that matches current repo terminology
Capitalize NVIDIA correctly in all documentation and public-facing text
Format code, commands, paths, and filenames as inline code (monospace) in documentation
Use descriptive anchor text for links instead of bare URLs or weak labels like 'here' in documentation
Prefer active voice, present tense, short sentences, and plain English in documentation
Structure documentation procedures as imperative steps that are easy to scan and not too long for a single sequence
Prefer 'after' instead of 'once' for temporal references in documentation
Use 'can' instead of 'may' when describing possibility (rather than permission) in documentation
Avoid ambiguous numeric dates and ordinal dates in documentation body text
Files:
docs/integrations/about.mdskills/nemo-flow-tune-performance/SKILL.md
{README.md,docs/**/*.md,examples/**/*.{js,ts,py,go,rs}}
📄 CodeRabbit inference engine (.agents/skills/maintain-packaging/SKILL.md)
Keep documentation and examples synchronized with current install, import, and build commands
Files:
docs/integrations/about.md
**/*.{py,js,ts,tsx,go,rs,md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
Format changed files with the language-native formatter before the final lint/test pass
Files:
docs/integrations/about.mdskills/nemo-flow-tune-performance/SKILL.md
{README.md,CONTRIBUTING.md,docs/**/*.md}
📄 CodeRabbit inference engine (.agents/skills/validate-change/SKILL.md)
For docs-only changes, run targeted checks only if commands, package names, or examples changed. Use
just docsfor docs-site builds andjust docs-linkcheckwhen links changed
Files:
docs/integrations/about.md
docs/**/*.{md,yaml,yml,json}
📄 CodeRabbit inference engine (.agents/skills/maintain-optimizer/SKILL.md)
Update examples showing canonical config shapes in documentation when modifying the adaptive surface
Files:
docs/integrations/about.md
{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}
⚙️ CodeRabbit configuration file
{docs/**,README.md,CONTRIBUTING.md,RELEASING.md,SECURITY.md}: Review documentation for technical accuracy against the current API, command correctness, and consistency across language bindings.
Flag stale examples, missing SPDX headers where required, and instructions that no longer match CI or pre-commit behavior.
Files:
docs/integrations/about.md
**/SKILL.md
📄 CodeRabbit inference engine (AGENTS.md)
SKILL.md files are skill entrypoints and do not need SPDX headers, but they must always start with YAML frontmatter containing at least
nameanddescription.
Files:
skills/nemo-flow-tune-performance/SKILL.md
⚙️ CodeRabbit configuration file
**/SKILL.md: Do not flag SKILL.md files for missing SPDX headers. Skill entrypoints intentionally start with YAML frontmatter instead.
Verify that every SKILL.md keeps valid YAML frontmatter with at least name and description fields before the Markdown body.
Files:
skills/nemo-flow-tune-performance/SKILL.md
🧠 Learnings (1)
📓 Common learnings
Learnt from: CR
Repo: NVIDIA/NeMo-Flow
Timestamp: 2026-05-21T19:48:38.741Z
Learning: Add tests in every affected language surface when adding a binding feature
Learnt from: CR
Repo: NVIDIA/NeMo-Flow
Timestamp: 2026-05-21T19:48:38.741Z
Learning: Ensure SPDX license header is present on any new files
Learnt from: CR
Repo: NVIDIA/NeMo-Flow
Timestamp: 2026-05-21T19:48:38.741Z
Learning: Update relevant pages under `docs/reference/` when adding a binding feature
Learnt from: CR
Repo: NVIDIA/NeMo-Flow
Timestamp: 2026-05-21T19:48:38.741Z
Learning: Update `README.md`, `docs/getting-started/`, or binding-level READMEs when behavior differs by language
Learnt from: CR
Repo: NVIDIA/NeMo-Flow
Timestamp: 2026-05-21T19:48:38.741Z
Learning: Update relevant getting-started, README, or example docs when usage changed
Learnt from: CR
Repo: NVIDIA/NeMo-Flow
Timestamp: 2026-05-21T19:48:38.741Z
Learning: Use `karpathy-guidelines` alongside this skill for implementation or review work, keeping changes scoped and surfacing assumptions
Learnt from: CR
Repo: NVIDIA/NeMo-Flow
Timestamp: 2026-05-21T19:48:38.741Z
Learning: Follow existing patterns already implemented across core, FFI, Python, Go, Node.js, and WebAssembly rather than inventing new shapes
Learnt from: CR
Repo: NVIDIA/NeMo-Flow
Timestamp: 2026-05-21T19:48:48.678Z
Learning: Maintain consistency of dynamic config shape with the documented canonical model in the adaptive surface
Learnt from: CR
Repo: NVIDIA/NeMo-Flow
Timestamp: 2026-05-21T19:48:48.678Z
Learning: Keep Node/WebAssembly adaptive helpers and plugin wrappers synchronized with changes to plugin lifecycle and composition
Learnt from: CR
Repo: NVIDIA/NeMo-Flow
Timestamp: 2026-05-21T19:48:48.678Z
Learning: Ensure typed helper constructors in language bindings map cleanly to the documented config document structure
Learnt from: CR
Repo: NVIDIA/NeMo-Flow
Timestamp: 2026-05-21T19:48:48.678Z
Learning: Ensure plugin lifecycle is consistent across all language implementations (Rust, Python, Go, Node/WebAssembly)
Learnt from: CR
Repo: NVIDIA/NeMo-Flow
Timestamp: 2026-05-21T19:48:48.678Z
Learning: Ensure plugin context surfaces remain aligned across all language bindings
Learnt from: CR
Repo: NVIDIA/NeMo-Flow
Timestamp: 2026-05-21T19:48:48.678Z
Learning: Update validation and report behavior documentation when making changes to the adaptive surface
Learnt from: CR
Repo: NVIDIA/NeMo-Flow
Timestamp: 2026-05-21T19:48:48.678Z
Learning: Ensure any new adaptive component kind has accompanying documentation, examples, and coverage across all language bindings
🔇 Additional comments (6)
skills/nemo-flow-tune-performance/SKILL.md (6)
1-6: LGTM!
13-20: LGTM!
34-48: LGTM!
50-58: LGTM!
60-67: LGTM!
69-82: Missing context: provide the original<review_comment>(and any verification outputs) so I can rewrite it in the required format
|
/merge |
2 participants
Overview
Adds Phase 2 adaptive tuning skill coverage and updates the public skill/docs framing from optimizer-oriented names to tune-oriented names.
Details
Where should the reviewer start?
Start with
skills/nemo-flow-tune-performance/SKILL.md, then review the alias treatment inskills/nemo-flow-start-optimizer/SKILL.md,skills/nemo-flow-configure-optimizer/SKILL.md, andskills/nemo-flow-use-optimizer-hints/SKILL.md.Validation:
git diff --checkjust docsjust docs-linkcheckuv run pre-commit run --from-ref upstream/main --to-ref HEADRelated Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)
Summary by CodeRabbit
Documentation
Deprecations