Skip to content

feat(customizer): add docs and skills for customizer rl backend#495

Merged
anubhutivyas merged 1 commit into
mainfrom
299-dpo-docs/anubhutiv
Jul 2, 2026
Merged

feat(customizer): add docs and skills for customizer rl backend#495
anubhutivyas merged 1 commit into
mainfrom
299-dpo-docs/anubhutiv

Conversation

@anubhutivyas

@anubhutivyas anubhutivyas commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Summary by CodeRabbit

  • New Features
    • Added an end-to-end Jupyter notebook tutorial for running full-weight DPO customization jobs on the Ray-on-Kubernetes runtime.
    • Introduced expanded RL/DPO workflow documentation across job setup, dataset formats, integrations, and result reporting.
  • Documentation
    • Expanded NeMo Customizer skill guidance to cover submit-only backend routing and RL Kubernetes runtime requirements.
    • Added/updated batch sizing, RL hyperparameter, integrations setup, and troubleshooting references (including DPO-specific notes).
  • Tests
    • Added DPO test fixtures and contract validation coverage for RL job inputs and integrations.

@anubhutivyas
anubhutivyas requested review from a team as code owners June 29, 2026 08:24
@github-actions github-actions Bot added the feat label Jun 29, 2026
@github-actions

Copy link
Copy Markdown
Contributor

@anubhutivyas
anubhutivyas force-pushed the aalgo-292-dpo-support/anubhutiv branch 4 times, most recently from 80cd9ab to d9dc55f Compare July 1, 2026 00:02
@anubhutivyas
anubhutivyas force-pushed the 299-dpo-docs/anubhutiv branch from 3f60480 to 4dffd49 Compare July 1, 2026 00:03

@gabwow gabwow left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I think this can be improved with a little clean up

Comment thread plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/SKILL.md Outdated
Comment thread plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/SKILL.md Outdated
Comment thread plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/SKILL.md Outdated
Comment thread plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/SKILL.md Outdated
@gabwow

gabwow commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

LGTM

@anubhutivyas
anubhutivyas changed the base branch from aalgo-292-dpo-support/anubhutiv to main July 2, 2026 17:03
@anubhutivyas
anubhutivyas force-pushed the 299-dpo-docs/anubhutiv branch from d3282da to d220ea1 Compare July 2, 2026 17:39
@anubhutivyas
anubhutivyas enabled auto-merge July 2, 2026 17:39
@coderabbitai

coderabbitai Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Enterprise

Run ID: 168b7481-4946-441d-8bc2-4979cf245d28

📥 Commits

Reviewing files that changed from the base of the PR and between d220ea1 and db6e2d1.

📒 Files selected for processing (17)
  • docs/customizer/tutorials/dpo-customization-job.ipynb
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/SKILL.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/batch-sizing.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/dataset-formats.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/hf-conversion.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/hyperparameters-automodel.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/hyperparameters-rl.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/hyperparameters-unsloth.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/hyperparameters.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/integrations-setup.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/reporting.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/rl-kubernetes-runtime.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/troubleshooting.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/tests.json
  • plugins/nemo-rl/tests/fixtures/integrations_wandb_mlflow.json
  • plugins/nemo-rl/tests/fixtures/minimal_dpo.json
  • plugins/nemo-rl/tests/test_contract_job_inputs.py
✅ Files skipped from review due to trivial changes (10)
  • plugins/nemo-rl/tests/fixtures/integrations_wandb_mlflow.json
  • plugins/nemo-rl/tests/fixtures/minimal_dpo.json
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/rl-kubernetes-runtime.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/hf-conversion.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/troubleshooting.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/tests.json
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/hyperparameters-unsloth.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/integrations-setup.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/batch-sizing.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/hyperparameters-automodel.md
🚧 Files skipped from review as they are similar to previous changes (4)
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/reporting.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/hyperparameters-rl.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/hyperparameters.md
  • docs/customizer/tutorials/dpo-customization-job.ipynb

📝 Walkthrough

Walkthrough

Adds a DPO tutorial notebook and expands NeMo Customizer docs and tests to cover the rl backend, including job JSON references, runtime requirements, reporting guidance, and contract fixtures.

Changes

DPO/RL Documentation and Tutorial

Layer / File(s) Summary
DPO tutorial notebook
docs/customizer/tutorials/dpo-customization-job.ipynb
Adds an end-to-end DPO tutorial: dataset prep, fileset and secret setup, model creation, job submission/polling, output retrieval, optional deployment, and inference call.
SKILL.md rl backend integration
plugins/nemo-customizer/.../SKILL.md
Expands the skill to route DPO to rl, enforce Kubernetes runtime for rl, and add backend-specific workflow, gotchas, and fast paths.
Reference docs for automodel/unsloth/rl hyperparameters and batching
plugins/nemo-customizer/.../references/*
Adds rl/DPO job JSON, runtime, dataset, batching, integrations, troubleshooting, and backend reference updates.
Reporting template for terminal job status
plugins/nemo-customizer/.../references/reporting.md
Adds a standardized report template for terminal job status and output handling across backends.
RL contract tests and fixtures
plugins/nemo-rl/tests/fixtures/*, plugins/nemo-rl/tests/test_contract_job_inputs.py, plugins/nemo-customizer/.../tests.json
Adds DPO fixtures, a RlJobInput contract test, and new skill test cases for rl/DPO.

Possibly related PRs

Suggested labels: docs

Suggested reviewers: mckornfield, gabwow

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: adding docs and skill support for the customizer RL backend.
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.
✨ 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 299-dpo-docs/anubhutiv

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

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Actionable comments posted: 5

🤖 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/customizer/tutorials/dpo-customization-job.ipynb`:
- Around line 302-304: The persisted resource names are using too short a random
suffix, which can cause collisions across reruns in shared workspaces. Update
the suffix generation in the notebook setup cells that define job_suffix,
OUTPUT_NAME, DEPLOYMENT_CONFIG_NAME, and DEPLOYMENT_NAME to use a longer
UUID-derived suffix with more entropy. Keep the naming pattern the same, but
increase the suffix length consistently wherever these resource names are
constructed.

In
`@plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/batch-sizing.md`:
- Around line 145-150: The markdown table in the batch-sizing reference has a
broken row in the troubleshooting section because the Loss not moving entry is
being split into too many cells. Update that row in the table so it has only the
expected columns, using the existing troubleshooting entry near the Unsloth
guidance, and move the example/extra detail out of the table if needed to keep
the table rendering correctly.

In
`@plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/dataset-formats.md`:
- Around line 3-5: The dataset-format intro mixes the SFT and DPO filename
contracts, so separate the backend guidance into distinct sentences in the
dataset-formats reference. Update the text around the shared upload instructions
to clearly distinguish automodel/unsloth usage of train.jsonl and
validation.jsonl from the rl/DPO requirement for training.jsonl and
validation.jsonl, using the existing backend names and dataset field references
to keep each contract unambiguous.

In
`@plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/hf-conversion.md`:
- Line 58: The portability claim is too broad: in the hf-conversion doc, narrow
the statement around the `to_sft` flow so it only says the
chat-template/messages path is backend-agnostic. Update the wording near the SFT
backend note to reflect that the converted JSONL may be reused for both
Automodel and Unsloth only when produced through the chat-template/messages
path, and avoid implying `to_sft` itself is Unsloth-compatible.

In
`@plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/hyperparameters-rl.md`:
- Line 45: The `hyperparameters-rl.md` table entry for `max_steps` currently
reads like a hard rule in the `max_steps` description, but it should be a
smoke-job caveat instead. Update the wording in the `max_steps` row under the
hyperparameters reference so `epochs` is not presented as invalid when used with
`max_steps`, and make sure the `max_steps`/`epochs` guidance in this section
matches the smoke fixture behavior without implying JSON validation rejection.
🪄 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: 5064df78-fda1-40b3-829f-aea048090b8d

📥 Commits

Reviewing files that changed from the base of the PR and between 8a0c5c2 and d220ea1.

📒 Files selected for processing (17)
  • docs/customizer/tutorials/dpo-customization-job.ipynb
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/SKILL.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/batch-sizing.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/dataset-formats.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/hf-conversion.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/hyperparameters-automodel.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/hyperparameters-rl.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/hyperparameters-unsloth.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/hyperparameters.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/integrations-setup.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/reporting.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/rl-kubernetes-runtime.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/references/troubleshooting.md
  • plugins/nemo-customizer/src/nemo_customizer/skills/nemo-customizer/tests.json
  • plugins/nemo-rl/tests/fixtures/integrations_wandb_mlflow.json
  • plugins/nemo-rl/tests/fixtures/minimal_dpo.json
  • plugins/nemo-rl/tests/test_contract_job_inputs.py

Comment thread docs/customizer/tutorials/dpo-customization-job.ipynb Outdated
@github-actions

github-actions Bot commented Jul 2, 2026

Copy link
Copy Markdown
Contributor
Suite Lines Covered Line Rate Branch Rate
Unit Tests 22524/29649 76.0% 60.9%
Integration Tests 13011/28329 45.9% 19.4%

@anubhutivyas
anubhutivyas force-pushed the 299-dpo-docs/anubhutiv branch from d220ea1 to db6e2d1 Compare July 2, 2026 19:18
@anubhutivyas
anubhutivyas added this pull request to the merge queue Jul 2, 2026
Merged via the queue into main with commit 8e93a8e Jul 2, 2026
56 checks passed
@anubhutivyas
anubhutivyas deleted the 299-dpo-docs/anubhutiv branch July 2, 2026 19:40
arpitsardhana pushed a commit that referenced this pull request Jul 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants