Repository navigation
docs: add ABCD synthetic agent conversation dev note Part 1 - #774
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the
Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info
📜 Recent review details
WalkthroughThe documentation adds conditional compact-table styling and an article about converting ABCD conversations into synthetic training data and evaluating the generated conversations. ChangesCompact-table presentation
ABCD synthetic-data article
Priority: ⬇️ Low Estimated code review effort: 2 (Simple) | ~15 minutes Change: Feature Suggested labels: Suggested reviewers: Merge Risk: 🔵 Low · up to
|
[Low impact] Adds documentation and styling for a dev note post. The previous findings remain unresolved, including the tutorial’s unsupported release and the check that misses decreasing fractional timestamps. Findings
SummaryAdds Part 1 of the ABCD conversation synthesis notes.
Reviews (6) · Last reviewed commit: "docs: move ABCD dev note Part 2 to a sep..." · Reviewed by Greptile |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
a708488 to
a76987d
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
ℹ️ Review info
⚙️ Run configuration
- Configuration used: Repository: NVIDIA-NeMo/Safe-Synthesizer/.coderabbit.yaml
- Review profile: CHILL
- Plan: Enterprise
- Run ID:
c50f44f5-2a57-4dc1-a3bf-db44ecce11b7
⛔ Files ignored due to path filters: 4
docs/dev-notes/posts/assets/abcd-conversations-to-synthetic-training-data/action-mix.pngis excluded by!**/*.pngdocs/dev-notes/posts/assets/abcd-conversations-to-synthetic-training-data/conversation-length.pngis excluded by!**/*.pngdocs/dev-notes/posts/assets/abcd-conversations-to-synthetic-training-data/downstream-utility.pngis excluded by!**/*.pngdocs/dev-notes/posts/assets/abcd-conversations-to-synthetic-training-data/membership-inference.pngis excluded by!**/*.png
📒 Files selected for processing: 1
docs/dev-notes/posts/abcd-conversations-to-synthetic-training-data.md
Included review availability: This review used your included allowance. Your plan provides up to 12 included reviews per hour; 11 remain after this review.
📜 Review details
⏰ Context from checks skipped due to timeout: 8
- GitHub Check: Unit Tests (3.12)
- GitHub Check: Unit Tests (3.13)
- GitHub Check: Unit Tests (3.14)
- GitHub Check: Unit Tests (3.11)
- GitHub Check: Greptile Review
- GitHub Check: Typecheck
- GitHub Check: Analyze (Python)
- GitHub Check: Analyze (python)
🧰 Additional context used
📚 Code guidelines: 2
CONTRIBUTING.md — configured
STYLE_GUIDE.md — configured
📓 Path-based instructions: 6
Review documentation as MkDocs Material content.
⚙️ CodeRabbit configuration file
Files:
docs/dev-notes/posts/abcd-conversations-to-synthetic-training-data.md
Review as a senior maintainer for NeMo Safe Synthesizer.
⚙️ CodeRabbit configuration file
Files:
docs/dev-notes/posts/abcd-conversations-to-synthetic-training-data.md
Source excerpt: All source files (`.py`, `.sh`, `.yaml`, `.yml`, `.md`) require SPDX copyright headers.
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Files:
docs/dev-notes/posts/abcd-conversations-to-synthetic-training-data.md
Source excerpt: Create or edit the `.md` file under the appropriate `docs/` subdirectory.
📄 CodeRabbit inference engine (CONTRIBUTING.md)
Files:
docs/dev-notes/posts/abcd-conversations-to-synthetic-training-data.md
Source excerpt: Documentation pages (in `docs/`): classify as tutorial, how-to, explanation, or reference per the [Diataxis framework](https://diataxis.fr/).
📄 CodeRabbit inference engine (STYLE_GUIDE.md)
Files:
docs/dev-notes/posts/abcd-conversations-to-synthetic-training-data.md
Source excerpt: Use `--` (em-dash) for asides, not `-` (hyphen).
📄 CodeRabbit inference engine (STYLE_GUIDE.md)
Files:
docs/dev-notes/posts/abcd-conversations-to-synthetic-training-data.md
🪛 LanguageTool
docs/dev-notes/posts/abcd-conversations-to-synthetic-training-data.md
[style] ~118-~118: If you’re making a request, consider inserting ‘please’ to sound more courteous and respectful.
Context: ...rance | | hi! i need to return an item, can you help me with that? | return_size | | []...
(CAN_YOU)
🪛 markdownlint-cli2 (0.23.3)
docs/dev-notes/posts/abcd-conversations-to-synthetic-training-data.md
[warning] 148-148: Code block style
Expected: fenced; Actual: indented
(MD046, code-block-style)
[warning] 176-176: Code block style
Expected: fenced; Actual: indented
(MD046, code-block-style)
🔇 Additional comments: 1
docs/dev-notes/posts/abcd-conversations-to-synthetic-training-data.md: 1
190-190: 🔒 Security & PrivacyThe
replace_pii: nullexample disables PII replacement.
replace_piiusesNoneas its disabled signal. The CLI configuration accepts explicitnull, and the processing path skipsNemoPIIwhenreplace_pii is None. The example is consistent with the SDK’senable=Falseconfiguration.
a76987d to
d65e62a
Compare
d65e62a to
d9e0df3
Compare
Add a two-part dev-note series on synthesizing and tuning agent conversations with ABCD, with figures, and compact table styling for pages that opt in via compact_tables front matter. Signed-off-by: seayang <seayang@nvidia.com> Signed-off-by: Sean Yang <seayang@nvidia.com>
Signed-off-by: Sean Yang <seayang@nvidia.com>
Signed-off-by: Sean Yang <seayang@nvidia.com>
Signed-off-by: Sean Yang <seayang@nvidia.com>
d9e0df3 to
ce31cd4
Compare
Summary
Adding dev notes on ABCD (agent conversation) experiments.
This PR includes the first part of a two post series.
Proposal doc
Human review
Select exactly one. The default is no human review; uncheck it when choosing another level.
Verification performed:
Pre-Review Checklist
Ensure that the following pass:
mise run formatleaves only intended formatting changes.mise run check ::: testpasses locally.mise run test:e2epasses locallymise run test:ci-containerpasses locally (recommended)/syncon this PR to trigger a run (auto-triggers on ready-for-review)Pre-Merge Checklist
Other Notes
Summary by CodeRabbit