MULocBench / README.md
sssssssssssshug's picture
Update README.md
95f80f1 verified
metadata
task_categories:
  - text-retrieval
tags:
  - code
  - software-development
  - issue-localization
  - bug-fixing
language:
  - en

This repository hosts MULocBench, a comprehensive dataset.

MULocBench addresses limitations in existing benchmarks by focusing on accurate project localization (e.g., files and functions) for issue resolution, which is a critical first step in software maintenance. It comprises 1,100 issues from 46 popular GitHub Python projects, offering greater diversity in issue types, root causes, location scopes, and file types compared to prior datasets. This dataset provides a more realistic testbed for evaluating and advancing methods for multi-faceted issue resolution.

1. Downloads

Please download the benchmark from https://huggingface.co/datasets/somethingone/MULocBench/blob/main/all_issues_with_pr_commit_comment_all_project_0922.pkl

If you’d like to view the data directly, you can download the JSON file and then open the json file using your browser

2. How to Use DataSet

import pickle
filepath = "input the data path, e.g., all_issues_with_pr_commit_comment_all_project_0922.pkl"
with open(filepath, 'rb') as file:
    iss_list = pickle.load(file)
    for ind, e_iss in enumerate(iss_list):
        print(f"{ind} issue info is {e_iss['iss_html_url']}") # print issue html url
        for featurename in e_iss:
            print(f"{featurename}: {e_iss[featurename]}") # print feature_name: value for each issue

3. Data Instances

An example of an issue is as follows:

organization: (str) - Organization name.
repo_name: (str) - Repository name.
iss_html_url: (str) - Issue html url.
title: (str) - Issue title.
label: (str) - Issue lable.
body: (str) - Issue body.
pr_html_url: (str) - Pull request html url corresponding to the issue.
commit_html_url: (str) - Commit html url corresponding to the issue.
file_loc: (dict) - Within-Project location information.
own_code_loc: (list) - User-Authored location information.
ass_file_loc: (list) - Runtime-file location information.
other_rep_loc: (list) - Third-Party-file location information.
analysis: (dict) - Issue type, reason, location scope and type.
base_commit: (str) - The commit hash of the repository representing the HEAD of the repository before the issue.