Skip to content

feat: CodeRAG-Bench benchmark Version 0.1 - #2362

Open
boerz-coding wants to merge 39 commits into
masterfrom
feat-code_rag_bench
Open

boerz-coding wants to merge 39 commits into
masterfrom
feat-code_rag_bench

Conversation

@boerz-coding

Copy link
Copy Markdown
Collaborator

Description

I have moved my PR #2199 from my forked repo to the main repo, to allow proper chaining with follow-up PRs and CI testing.

This PR implements Version 0.1 (MVP) of the CodeRAG-Bench benchmark (issue #1462).

Introduction

CodeRAG-Bench is designed to enable rigorous evaluations and advance research on retrieval-augmented code generation.

Reference: CodeRAG-Bench Homepage

Current Status (v0.1)

This MVP supports:

  • Canonical retrieval and generation evaluation for the HumanEval sub-task.
  • Saving retrieval results, generations, and evaluation metrics.
  • Full retrieval-generation-evaluation pipeline for initial testing and feedback.

Note:
The full benchmark includes 7 code generation tasks (HumanEval, MBPP, LiveCodeBench, DS-1000, ODEX, RepoEval, SWE-bench-Lite), and both canonical and open-corpus retrieval. This MVP focuses on the first task (HumanEval) with canonical retrieval only.

The goal of this MVP is to provide an early working version for feedback and for potential users to start experimenting.

Example Output Files

Benchmark output files (retrieval results, generations, evaluation metrics) are available here for reproducibility.

Next Steps (Mini Roadmap)

I will continue working towards the full CodeRAG-Bench implementation. I also plan to split tasks into sub-issues to invite community contributions whenever possible.

Planned next steps:

  • Support open-corpus retrieval for HumanEval.
  • Add support for the other 6 tasks (MBPP, LiveCodeBench, DS-1000, ODEX, RepoEval, SWE-bench-Lite) across retrieval and generation stages.
  • (Optional) Add parallelization support.
  • Write a Cookbook for quickstart and usage examples.

Checklist

Go over all the following points, and put an x in all the boxes that apply.

  • [x ] I have read the CONTRIBUTION guide (required)
  • I have linked this PR to an issue using the Development section on the right sidebar or by adding Fixes #issue-number in the PR description (required)
  • I have checked if any dependencies need to be added or updated in pyproject.toml and uv lock
  • I have updated the tests accordingly (required for a bug fix or a new feature)
  • I have updated the documentation if needed:
  • I have added examples if this is a new feature

If you are unsure about any of these, don't hesitate to ask. We are here to help!

boerz-coding and others added 28 commits April 16, 2025 02:42
Done:
- Implemented basic logic for downloading and preprocessing the "humaneval" sub-task
- Created initial directory structure for CodeRAG benchmark; due to its complexity, it is placed in a separate folder
- Added function signatures for the benchmark class

Ongoing:
- Canonical retrieval implementation for the "humaneval" sub-task

To be done:
- Support for the remaining 6 sub-tasks
- Generation support
- Open-retrieval support
- test/examples
Completed basic logics for HumanEval benchmark
Temporary draft, need further edit.
- Edited the way retrieval result is saved
- Edited the way for generating prompts
- Implemented code post-processing

Next Step: Implement the code evaluation logic
(To evaluate code, we need to actually run it, so is somewhat
 challenging)
- Implemented evaluation logic for Humaneval, using relevant files from
coderag-bench (now in
	camel/benchmarks/coderag_bench/code_generation_evaluation)
- Adjusted the output structure of generation step to match the expected format in compute_code_eval.
- Completed subset logics
- Still need further test, currently has dependency issues
- Humaneval is fully implemented and has passed test with a subset of 5
  lines of data

- Output logs should be cleaned before making PR public. The retriever
  part need to be considered carefully
Editing docstrings to complete a MVP version that supports full RAG (canonical) + evaluation process for HumanEval subtask.
Thank you Wendong. This is very helpful

Co-authored-by: Wendong-Fan <133094783+Wendong-Fan@users.noreply.github.com>
@boerz-coding boerz-coding self-assigned this May 8, 2025
@boerz-coding boerz-coding added this to the Sprint 28 milestone May 8, 2025
@boerz-coding boerz-coding changed the title Feat code rag bench feat: CodeRAG-Bench benchmark Version 0.1 May 8, 2025
@boerz-coding boerz-coding added Agents Related to camel agents system New Feature and removed Agents Related to camel agents system labels May 8, 2025
@boerz-coding

Copy link
Copy Markdown
Collaborator Author

Hi @zjrwtx I have edited all docstrings. Thank you for your helpful comments.

@boerz-coding

boerz-coding commented May 11, 2025 •

Copy link
Copy Markdown
Collaborator Author

Hi @Wendong-Fan, I’ve addressed all comments from you and Yifeng — the PR is ready for review again.

Since this PR was moved from my forked repo to the main repo and your comments was left on the original PR , I wanted to recap the key changes from previous reviews:

  • Polished docstrings.
  • Applied lazy loading for optional packages like beir.
  • Refactored the content of CodeRAGBenchmark.run() into multiple sub-functions for better readability and modularity.
  • Updated retriever interface: CodeRAGBenchmark.run() now accepts any callable retriever functions instead of requiring a specific Retriever type.

@Wendong-Fan Wendong-Fan added the Review Required PR need to be reviewed label May 18, 2025
@coderabbitai

coderabbitai Bot commented Jun 29, 2025

Copy link
Copy Markdown
Contributor

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@boerz-coding boerz-coding removed the Review Required PR need to be reviewed label Jun 29, 2025

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

3 participants