Conversation
There was a problem hiding this comment.
Pull request overview
This pull request introduces comprehensive documentation for benchmark datasets in the EvalScope evaluation framework. It adds detailed benchmark documentation files and updates the build system to support automated documentation generation.
Changes:
- Added 60+ new benchmark documentation files in
docs/en/benchmarks/covering diverse evaluation datasets (math, coding, multimodal, reasoning, etc.) - Updated
Makefilewith new documentation generation targets and workflow automation - Modified
.pre-commit-config.yamlto exclude JSON files from end-of-file-fixer checks
Reviewed changes
Copilot reviewed 120 out of 637 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
docs/en/benchmarks/*.md |
Comprehensive documentation for 60+ benchmark datasets including properties, usage examples, and evaluation details |
Makefile |
Added documentation generation targets with parameters for translation, statistics, and selective updates |
.pre-commit-config.yaml |
Excluded JSON files from end-of-file-fixer to prevent formatting issues |
Summary of ChangesHello @Yunnglin, 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 significantly enhances the project's documentation by integrating detailed information for a wide array of benchmarks. This includes task descriptions, key features, evaluation notes, and usage examples for each benchmark, making it easier for users to understand and utilize them. The underlying documentation generation process has also been modernized for better maintainability and flexibility. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. 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.
Code Review
This pull request is a significant contribution, adding detailed documentation for a vast number of benchmarks and introducing new tooling to automate documentation generation, translation, and updates. The new Makefile targets and the underlying Python scripts are well-structured and will greatly improve the maintainability of the project's documentation.
My review focuses on two main areas for improvement:
- Refactoring the
Makefilefor better readability and maintainability. - Improving the format of sample data in the generated documentation to avoid stringified JSON, which enhances clarity for users.
Overall, this is excellent work.
| .PHONY: docs-update | ||
| docs-update: | ||
| ifdef BENCHMARK | ||
| python -m evalscope.cli.cli benchmark-info $(BENCHMARK) --update | ||
| else | ||
| python -m evalscope.cli.cli benchmark-info --all --update | ||
| endif | ||
|
|
||
| .PHONY: docs-update-stats | ||
| docs-update-stats: | ||
| ifdef BENCHMARK | ||
| python -m evalscope.cli.cli benchmark-info $(BENCHMARK) --update --compute-stats | ||
| else | ||
| python -m evalscope.cli.cli benchmark-info --all --update --compute-stats | ||
| endif | ||
|
|
||
| .PHONY: docs-translate | ||
| docs-translate: | ||
| ifdef BENCHMARK | ||
| ifdef FORCE | ||
| python -m evalscope.cli.cli benchmark-info $(BENCHMARK) --translate --force --workers $(WORKERS) | ||
| else | ||
| python -m evalscope.cli.cli benchmark-info $(BENCHMARK) --translate --workers $(WORKERS) | ||
| endif | ||
| else | ||
| ifdef FORCE | ||
| python -m evalscope.cli.cli benchmark-info --translate --force --workers $(WORKERS) | ||
| else | ||
| python -m evalscope.cli.cli benchmark-info --translate --workers $(WORKERS) | ||
| endif | ||
| endif |
There was a problem hiding this comment.
The logic for docs-update, docs-update-stats, and docs-translate is quite repetitive. You can refactor this to make it more concise and maintainable by using variables for the arguments. This will reduce duplication and make it clearer how arguments like BENCHMARK and FORCE are handled.
BENCHMARK_ARG_UPDATE = $(if $(BENCHMARK),$(BENCHMARK),--all)
FORCE_ARG = $(if $(FORCE),--force,)
.PHONY: docs-update
docs-update:
python -m evalscope.cli.cli benchmark-info $(BENCHMARK_ARG_UPDATE) --update
.PHONY: docs-update-stats
docs-update-stats:
python -m evalscope.cli.cli benchmark-info $(BENCHMARK_ARG_UPDATE) --update --compute-stats
.PHONY: docs-translate
docs-translate:
python -m evalscope.cli.cli benchmark-info $(BENCHMARK) --translate $(FORCE_ARG) --workers $(WORKERS)
| "group_id": 0, | ||
| "metadata": { | ||
| "question_id": "22jbM6gDxdaMaunuzgrsBB", | ||
| "direct_answers": "['cigarette', 'cigarette', 'cigarette', 'cigarette', 'cigarette', 'cigarette', 'cigarette', 'cigarette', 'cigarette', 'cigarette']", |
There was a problem hiding this comment.
In the sample example JSON, the value for direct_answers is a string representation of a list, rather than a proper JSON array. This can be confusing for users trying to understand the data format. It would be more clear and correct to represent it as a JSON array.
This issue of stringifying complex data types appears in several other generated documentation files as well (e.g., target in drop.md, content in bfcl_v3.md). It would be great to fix the documentation generation script to output proper JSON structures for these fields.
| "direct_answers": "['cigarette', 'cigarette', 'cigarette', 'cigarette', 'cigarette', 'cigarette', 'cigarette', 'cigarette', 'cigarette', 'cigarette']", | |
| "direct_answers": [ | |
| "cigarette", | |
| "cigarette", | |
| "cigarette", | |
| "cigarette", | |
| "cigarette", | |
| "cigarette", | |
| "cigarette", | |
| "cigarette", | |
| "cigarette", | |
| "cigarette" | |
| ], |
No description provided.