Add location for prompt optimization functions#1077
Add location for prompt optimization functions#1077rapids-bot[bot] merged 22 commits intoNVIDIA:release/1.3from
Conversation
Reorganized and enhanced the optimizer documentation with clearer explanations, improved structure, and examples. Added sections on parameter optimization concepts, genetic algorithms, best practices, and detailed configuration instructions to assist users in leveraging the optimizer effectively. Signed-off-by: dnandakumar-nv <dnandakumar@nvidia.com>
Introduced prompt optimization functionality and updated evaluation metrics for better profiling. Enhanced support for named metrics in visualizations and ensured backward compatibility with existing formats across pareto visualizer and data exports. Signed-off-by: dnandakumar-nv <dnandakumar@nvidia.com>
Replaced "rag_accuracy" and "rag_groundedness" with a single "accuracy" evaluator and updated related configurations to simplify metrics. Adjusted code formatting in `pareto_visualizer.py` for better readability and consistency. Disabled prompt optimization in the config as part of these changes. Signed-off-by: dnandakumar-nv <dnandakumar@nvidia.com>
Standardize code formatting for parameters and terms like `Chebyshev`, `step`, and `eval_metrics`. Improved phrasing to enhance readability and ensure uniformity across documentation. Signed-off-by: dnandakumar-nv <dnandakumar@nvidia.com>
Enclosed key terms like `accuracy/F1`, `style/tone`, and `population/generations` within backticks for better readability and consistency. This ensures clearer differentiation of important concepts in the documentation. Signed-off-by: dnandakumar-nv <dnandakumar@nvidia.com>
Corrected several typos (e.g., "discreet" to "discrete", "repos" to "reps") and improved phrasing for clarity and consistency. These changes enhance readability and ensure more accurate instructions for users. Signed-off-by: dnandakumar-nv <dnandakumar@nvidia.com>
Clarified the reference to the `email_phishing_analyzer` example by providing more precise context within the NeMo Agent toolkit repository. This improves readability and helps users quickly locate the relevant example. Signed-off-by: dnandakumar-nv <dnandakumar@nvidia.com>
Signed-off-by: Michael Demoret <mdemoret@nvidia.com>
Revised the genetic algorithm section for clarity, replacing redundant content and improving organization. Added practical tips for parameter tuning to aid users in optimizing prompt performance effectively. Signed-off-by: dnandakumar-nv <dnandakumar@nvidia.com>
The detailed explanation of Pareto visualizations was relocated from the example README to the optimizer's documentation for better organization and context. The README now references the optimizer documentation for this guide. Signed-off-by: dnandakumar-nv <dnandakumar@nvidia.com>
The detailed explanation of Pareto visualizations was relocated from the example README to the optimizer's documentation for better organization and context. The README now references the optimizer documentation for this guide. Signed-off-by: dnandakumar-nv <dnandakumar@nvidia.com>
Reversed annotation arrows for better clarity in Pareto visualizer. Updated documentation to include example images for visualizations, enhancing user understanding. Added new static image files used in the documentation. Signed-off-by: dnandakumar-nv <dnandakumar@nvidia.com>
Reversed annotation arrows for better clarity in Pareto visualizer. Updated documentation to include example images for visualizations, enhancing user understanding. Added new static image files used in the documentation. Signed-off-by: dnandakumar-nv <dnandakumar@nvidia.com>
Added references to built-in `prompt_init` and `prompt_recombiner` functions in the NeMo Agent Toolkit within the optimizer documentation. This provides clearer guidance on available options for population initialization and recombination. Signed-off-by: dnandakumar-nv <dnandakumar@nvidia.com>
|
/ok to test f2ab0e3 |
WalkthroughDocumentation additions to two optimizer configuration fields in the reference guide, clarifying available built-in toolkit functions for prompt initialization and recombination configuration. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
/ok to test 08176b4 |
There was a problem hiding this comment.
Actionable comments posted: 1
📜 Review details
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/source/reference/optimizer.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (3)
docs/source/**/*.md
📄 CodeRabbit inference engine (.cursor/rules/general.mdc)
docs/source/**/*.md: Use the official naming throughout documentation: first use “NVIDIA NeMo Agent toolkit”, subsequent “NeMo Agent toolkit”; never use deprecated names (Agent Intelligence toolkit, aiqtoolkit, AgentIQ, AIQ/aiq)
Documentation sources are Markdown files under docs/source; images belong in docs/source/_static
Keep docs in sync with code; documentation pipeline must pass Sphinx and link checks; avoid TODOs/FIXMEs/placeholders; avoid offensive/outdated terms; ensure spelling correctness
Do not use words listed in ci/vale/styles/config/vocabularies/nat/reject.txt; accepted terms in accept.txt are allowed
Files:
docs/source/reference/optimizer.md
**/*
⚙️ CodeRabbit configuration file
**/*: # Code Review Instructions
- Ensure the code follows best practices and coding standards. - For Python code, follow
PEP 20 and
PEP 8 for style guidelines.- Check for security vulnerabilities and potential issues. - Python methods should use type hints for all parameters and return values.
Example:def my_function(param1: int, param2: str) -> bool: pass- For Python exception handling, ensure proper stack trace preservation:
- When re-raising exceptions: use bare
raisestatements to maintain the original stack trace,
and uselogger.error()(notlogger.exception()) to avoid duplicate stack trace output.- When catching and logging exceptions without re-raising: always use
logger.exception()
to capture the full stack trace information.Documentation Review Instructions - Verify that documentation and comments are clear and comprehensive. - Verify that the documentation doesn't contain any TODOs, FIXMEs or placeholder text like "lorem ipsum". - Verify that the documentation doesn't contain any offensive or outdated terms. - Verify that documentation and comments are free of spelling mistakes, ensure the documentation doesn't contain any
words listed in the
ci/vale/styles/config/vocabularies/nat/reject.txtfile, words that might appear to be
spelling mistakes but are listed in theci/vale/styles/config/vocabularies/nat/accept.txtfile are OK.Misc. - All code (except .mdc files that contain Cursor rules) should be licensed under the Apache License 2.0,
and should contain an Apache License 2.0 header comment at the top of each file.
- Confirm that copyright years are up-to date whenever a file is changed.
Files:
docs/source/reference/optimizer.md
docs/source/**/*
⚙️ CodeRabbit configuration file
This directory contains the source code for the documentation. All documentation should be written in Markdown format. Any image files should be placed in the
docs/source/_staticdirectory.
Files:
docs/source/reference/optimizer.md
|
/merge |
Description
Closes
By Submitting this PR I confirm:
Summary by CodeRabbit