Simplify custom evaluator definition #358
Merged
+392
−344
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…lass Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
AnuradhaKaruppiah
added
improvement
There was a problem hiding this comment.
Pull Request Overview
This PR introduces a new BaseEvaluator abstract class to centralize common evaluator logic and updates the documentation and example code to use it.
- Extract concurrency, progress bar, and average-score computation into
BaseEvaluator. - Simplify the similarity evaluator example to subclass
BaseEvaluator. - Refresh docs to explain the new extension flow with the
register_evaluatordecorator.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| src/aiq/eval/evaluator/custom_base_evaluator.py | New BaseEvaluator ABC with evaluate_item and shared evaluate method for custom evaluators |
| docs/source/extend/custom-evaluator.md | Updated guide to use BaseEvaluator and register_evaluator, streamlined similarity example |
Comments suppressed due to low confidence (3)
src/aiq/eval/evaluator/custom_base_evaluator.py:47
- There are no tests covering the new
BaseEvaluator.evaluatemethod. Add unit tests to verify concurrency limits, progress bar updates, and average-score logic for both numeric and non-numeric scores.
async def evaluate(self, eval_input: EvalInput) -> EvalOutput:
docs/source/extend/custom-evaluator.md:64
- Fix the typo in the description string: "Simlaity Evaluator" should be "Similarity Evaluator".
yield EvaluatorInfo(config=config, evaluate_fn=evaluator.evaluate, description="Simlaity Evaluator")
docs/source/extend/custom-evaluator.md:94
- The docs describe
EvalInputItemandEvalOutputItembut omit theEvalOutputtype returned byevaluate. Consider adding a section explaining its fields (e.g.,average_score,eval_output_items).
**EvalOutputItem**
Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
mdemoret-nv
previously requested changes
Jun 11, 2025
Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
yczhang-nv
approved these changes
Jun 12, 2025
Signed-off-by: Anuradha Karuppiah <anuradhak@nvidia.com>
AnuradhaKaruppiah
dismissed
mdemoret-nv’s stale review
Comments addressed, I am merging this after secondary review from Yuchen
|
/merge |
AnuradhaKaruppiah
added a commit
to AnuradhaKaruppiah/oss-agentiq
that referenced
this pull request
Aug 4, 2025
This PR introduces a new BaseEvaluator abstract class to centralize common evaluator logic and updates the documentation and example code to use it. - Extract concurrency, progress bar, and average-score computation into BaseEvaluator. - Simplify the similarity evaluator example to subclass BaseEvaluator. - Refresh docs to explain the new extension flow with the register_evaluator decorator. ## By Submitting this PR I confirm: - I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/AIQToolkit/blob/develop/docs/source/resources/contributing.md). - We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license. - Any contribution which contains commits that are not Signed-Off will not be accepted. - When the PR is ready for review, new or existing tests cover these changes. - When the PR is ready for review, the documentation is up to date with these changes. Authors: - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah) Approvers: - Yuchen Zhang (https://github.com/yczhang-nv) URL: NVIDIA#358
scheckerNV
pushed a commit
to scheckerNV/aiq-factory-reset
that referenced
this pull request
Aug 22, 2025
This PR introduces a new BaseEvaluator abstract class to centralize common evaluator logic and updates the documentation and example code to use it. - Extract concurrency, progress bar, and average-score computation into BaseEvaluator. - Simplify the similarity evaluator example to subclass BaseEvaluator. - Refresh docs to explain the new extension flow with the register_evaluator decorator. ## By Submitting this PR I confirm: - I am familiar with the [Contributing Guidelines](https://github.com/NVIDIA/AIQToolkit/blob/develop/docs/source/resources/contributing.md). - We require that all contributors "sign-off" on their commits. This certifies that the contribution is your original work, or you have rights to submit it under the same license, or a compatible license. - Any contribution which contains commits that are not Signed-Off will not be accepted. - When the PR is ready for review, new or existing tests cover these changes. - When the PR is ready for review, the documentation is up to date with these changes. Authors: - Anuradha Karuppiah (https://github.com/AnuradhaKaruppiah) Approvers: - Yuchen Zhang (https://github.com/yczhang-nv) URL: NVIDIA#358
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces a new BaseEvaluator abstract class to centralize common evaluator logic and updates the documentation and example code to use it.
By Submitting this PR I confirm: