-
Notifications
You must be signed in to change notification settings - Fork 64
docs: update documentation and tests to use new evaluator config format #312
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: update documentation and tests to use new evaluator config format #312
Conversation
Kylie-dot-s
commented
Dec 23, 2025
- Update docs to use new evaluator array config structure instead of deprecated prompt_list/rule_list/llm_config
- Fix relative path references in documentation (../../ -> proper paths)
- Update test files to use new InputArgs format with evaluator and dataset configs
- Update example links in eval documentation
Summary of ChangesHello @Kylie-dot-s, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a significant overhaul to the evaluator configuration system, moving from a fragmented approach to a more unified and flexible array-based structure. This change streamlines how evaluation pipelines are defined, allowing for clearer specification of data field mappings and the sequential application of multiple evaluators (both rule-based and LLM-based). The update also includes comprehensive documentation and test file adjustments to ensure consistency and ease of use with the new configuration paradigm. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request significantly refactors the configuration and usage of evaluators within the system, primarily by deprecating the dataset.field, executor.eval_group, executor.rule_list, and executor.prompt_list parameters. The core change introduces a new evaluator configuration, which is now an array of EvalPipline objects. Each EvalPipline defines fields for data mapping and an evals array containing individual evaluator configurations (with name and config parameters for both rule-based and LLM-based evaluators).
Documentation files (docs/config.md, docs/document_ocr.md, docs/eval/*, docs/factcheck_guide.md, docs/hallucination_guide.md, docs/html_extract_compare_v2.md, docs/image_lable_check_guide.md, docs/image_quality_check_guide.md, docs/layout_quality_guide.md, docs/posts/zhihu.md, docs/technical/*) have been updated to reflect this new structure, including revised configuration examples, Python SDK usage, and explanations of the new evaluator array. Specifically, prompt related concepts and parameters have been largely replaced or integrated into the new LLM evaluator structure, and LLM evaluators now explicitly require key and api_url in their config.
Several review comments highlight the need to remove deprecated eval_group parameters from example configurations in various documentation files to prevent user confusion and ensure consistency with the new configuration schema. Additionally, one comment suggests completing a partial JSON example in docs/config.md for better user clarity.
2808691 to
7f37164
Compare
- Update docs to use new evaluator array config structure instead of deprecated prompt_list/rule_list/llm_config - Fix relative path references in documentation (../../ -> proper paths) - Update test files to use new InputArgs format with evaluator and dataset configs - Update example links in eval documentation
7f37164 to
822e68f
Compare