Eval doc updates #322
Merged
Eval doc updates #322
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
1. Add a link to the RAGAS nv metrics prompts 2. Add a note that the RAGSA nv metrics prompts are not tunable. The user can instead use the "Tunable RAG Evaluator" or add their own "Custom Evaluator" 3. Add a note on the recommended max_tokens for Trajectory Evluator. Signed-off-by: Anuradha Karuppiah <[email protected]>
AnuradhaKaruppiah
force-pushed
the
ak-eval-docs
branch
from
47c0742 to
1551e42
Compare
AnuradhaKaruppiah
added
doc
There was a problem hiding this comment.
Pull Request Overview
This PR updates the evaluation documentation to provide clearer guidelines on judge LLM configurations and evaluator settings.
- Adds detailed explanations on the judge LLM's score and max_tokens configuration.
- Includes new links to the RAGAS NV metrics leadership board and prompt documentation.
- Clarifies the trajectory evaluator's output and configuration instructions.
Co-authored-by: Copilot <[email protected]> Signed-off-by: Anuradha Karuppiah <[email protected]>
Signed-off-by: Anuradha Karuppiah <[email protected]>
Signed-off-by: Anuradha Karuppiah <[email protected]>
dagardner-nv
approved these changes
May 29, 2025
|
/merge |
gfreeman-nvidia
pushed a commit
to gfreeman-nvidia/AIQToolkit
that referenced
this pull request
May 30, 2025
1. Add a link to the RAGAS nv metrics prompts 2. Add a note that the RAGAS nv metrics prompts are not tunable. The user can instead use the "Tunable RAG Evaluator" or add their own "Custom Evaluator" 3. Add a note on the recommended max_tokens for Trajectory Evluator. ## 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: - David Gardner (https://github.com/dagardner-nv) URL: NVIDIA#322 Signed-off-by: Greg Freeman <[email protected]>
ericevans-nv
pushed a commit
to ericevans-nv/agent-iq
that referenced
this pull request
Jun 3, 2025
1. Add a link to the RAGAS nv metrics prompts 2. Add a note that the RAGAS nv metrics prompts are not tunable. The user can instead use the "Tunable RAG Evaluator" or add their own "Custom Evaluator" 3. Add a note on the recommended max_tokens for Trajectory Evluator. ## 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: - David Gardner (https://github.com/dagardner-nv) URL: NVIDIA#322 Signed-off-by: Eric Evans <[email protected]>
ericevans-nv
pushed a commit
to ericevans-nv/agent-iq
that referenced
this pull request
Jun 3, 2025
1. Add a link to the RAGAS nv metrics prompts 2. Add a note that the RAGAS nv metrics prompts are not tunable. The user can instead use the "Tunable RAG Evaluator" or add their own "Custom Evaluator" 3. Add a note on the recommended max_tokens for Trajectory Evluator. ## 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: - David Gardner (https://github.com/dagardner-nv) URL: NVIDIA#322 Signed-off-by: Eric Evans <[email protected]>
ericevans-nv
pushed a commit
to ericevans-nv/agent-iq
that referenced
this pull request
Jun 3, 2025
1. Add a link to the RAGAS nv metrics prompts 2. Add a note that the RAGAS nv metrics prompts are not tunable. The user can instead use the "Tunable RAG Evaluator" or add their own "Custom Evaluator" 3. Add a note on the recommended max_tokens for Trajectory Evluator. ## 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: - David Gardner (https://github.com/dagardner-nv) URL: NVIDIA#322 Signed-off-by: Eric Evans <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
By Submitting this PR I confirm: