|
--- |
|
dataset_info: |
|
features: |
|
- name: url |
|
dtype: string |
|
- name: repository_url |
|
dtype: string |
|
- name: labels_url |
|
dtype: string |
|
- name: comments_url |
|
dtype: string |
|
- name: events_url |
|
dtype: string |
|
- name: html_url |
|
dtype: string |
|
- name: id |
|
dtype: int64 |
|
- name: node_id |
|
dtype: string |
|
- name: number |
|
dtype: int64 |
|
- name: title |
|
dtype: string |
|
- name: user |
|
struct: |
|
- name: avatar_url |
|
dtype: string |
|
- name: events_url |
|
dtype: string |
|
- name: followers_url |
|
dtype: string |
|
- name: following_url |
|
dtype: string |
|
- name: gists_url |
|
dtype: string |
|
- name: gravatar_id |
|
dtype: string |
|
- name: html_url |
|
dtype: string |
|
- name: id |
|
dtype: int64 |
|
- name: login |
|
dtype: string |
|
- name: node_id |
|
dtype: string |
|
- name: organizations_url |
|
dtype: string |
|
- name: received_events_url |
|
dtype: string |
|
- name: repos_url |
|
dtype: string |
|
- name: site_admin |
|
dtype: bool |
|
- name: starred_url |
|
dtype: string |
|
- name: subscriptions_url |
|
dtype: string |
|
- name: type |
|
dtype: string |
|
- name: url |
|
dtype: string |
|
- name: user_view_type |
|
dtype: string |
|
- name: labels |
|
list: |
|
- name: color |
|
dtype: string |
|
- name: default |
|
dtype: bool |
|
- name: description |
|
dtype: string |
|
- name: id |
|
dtype: int64 |
|
- name: name |
|
dtype: string |
|
- name: node_id |
|
dtype: string |
|
- name: url |
|
dtype: string |
|
- name: state |
|
dtype: string |
|
- name: locked |
|
dtype: bool |
|
- name: assignee |
|
struct: |
|
- name: avatar_url |
|
dtype: string |
|
- name: events_url |
|
dtype: string |
|
- name: followers_url |
|
dtype: string |
|
- name: following_url |
|
dtype: string |
|
- name: gists_url |
|
dtype: string |
|
- name: gravatar_id |
|
dtype: string |
|
- name: html_url |
|
dtype: string |
|
- name: id |
|
dtype: int64 |
|
- name: login |
|
dtype: string |
|
- name: node_id |
|
dtype: string |
|
- name: organizations_url |
|
dtype: string |
|
- name: received_events_url |
|
dtype: string |
|
- name: repos_url |
|
dtype: string |
|
- name: site_admin |
|
dtype: bool |
|
- name: starred_url |
|
dtype: string |
|
- name: subscriptions_url |
|
dtype: string |
|
- name: type |
|
dtype: string |
|
- name: url |
|
dtype: string |
|
- name: user_view_type |
|
dtype: string |
|
- name: assignees |
|
list: |
|
- name: avatar_url |
|
dtype: string |
|
- name: events_url |
|
dtype: string |
|
- name: followers_url |
|
dtype: string |
|
- name: following_url |
|
dtype: string |
|
- name: gists_url |
|
dtype: string |
|
- name: gravatar_id |
|
dtype: string |
|
- name: html_url |
|
dtype: string |
|
- name: id |
|
dtype: int64 |
|
- name: login |
|
dtype: string |
|
- name: node_id |
|
dtype: string |
|
- name: organizations_url |
|
dtype: string |
|
- name: received_events_url |
|
dtype: string |
|
- name: repos_url |
|
dtype: string |
|
- name: site_admin |
|
dtype: bool |
|
- name: starred_url |
|
dtype: string |
|
- name: subscriptions_url |
|
dtype: string |
|
- name: type |
|
dtype: string |
|
- name: url |
|
dtype: string |
|
- name: user_view_type |
|
dtype: string |
|
- name: milestone |
|
struct: |
|
- name: closed_at |
|
dtype: 'null' |
|
- name: closed_issues |
|
dtype: int64 |
|
- name: created_at |
|
dtype: string |
|
- name: creator |
|
struct: |
|
- name: avatar_url |
|
dtype: string |
|
- name: events_url |
|
dtype: string |
|
- name: followers_url |
|
dtype: string |
|
- name: following_url |
|
dtype: string |
|
- name: gists_url |
|
dtype: string |
|
- name: gravatar_id |
|
dtype: string |
|
- name: html_url |
|
dtype: string |
|
- name: id |
|
dtype: int64 |
|
- name: login |
|
dtype: string |
|
- name: node_id |
|
dtype: string |
|
- name: organizations_url |
|
dtype: string |
|
- name: received_events_url |
|
dtype: string |
|
- name: repos_url |
|
dtype: string |
|
- name: site_admin |
|
dtype: bool |
|
- name: starred_url |
|
dtype: string |
|
- name: subscriptions_url |
|
dtype: string |
|
- name: type |
|
dtype: string |
|
- name: url |
|
dtype: string |
|
- name: user_view_type |
|
dtype: string |
|
- name: description |
|
dtype: string |
|
- name: due_on |
|
dtype: 'null' |
|
- name: html_url |
|
dtype: string |
|
- name: id |
|
dtype: int64 |
|
- name: labels_url |
|
dtype: string |
|
- name: node_id |
|
dtype: string |
|
- name: number |
|
dtype: int64 |
|
- name: open_issues |
|
dtype: int64 |
|
- name: state |
|
dtype: string |
|
- name: title |
|
dtype: string |
|
- name: updated_at |
|
dtype: string |
|
- name: url |
|
dtype: string |
|
- name: comments |
|
sequence: string |
|
- name: created_at |
|
dtype: timestamp[ns, tz=UTC] |
|
- name: updated_at |
|
dtype: timestamp[ns, tz=UTC] |
|
- name: closed_at |
|
dtype: timestamp[ns, tz=UTC] |
|
- name: author_association |
|
dtype: string |
|
- name: active_lock_reason |
|
dtype: float64 |
|
- name: body |
|
dtype: string |
|
- name: closed_by |
|
struct: |
|
- name: avatar_url |
|
dtype: string |
|
- name: events_url |
|
dtype: string |
|
- name: followers_url |
|
dtype: string |
|
- name: following_url |
|
dtype: string |
|
- name: gists_url |
|
dtype: string |
|
- name: gravatar_id |
|
dtype: string |
|
- name: html_url |
|
dtype: string |
|
- name: id |
|
dtype: int64 |
|
- name: login |
|
dtype: string |
|
- name: node_id |
|
dtype: string |
|
- name: organizations_url |
|
dtype: string |
|
- name: received_events_url |
|
dtype: string |
|
- name: repos_url |
|
dtype: string |
|
- name: site_admin |
|
dtype: bool |
|
- name: starred_url |
|
dtype: string |
|
- name: subscriptions_url |
|
dtype: string |
|
- name: type |
|
dtype: string |
|
- name: url |
|
dtype: string |
|
- name: user_view_type |
|
dtype: string |
|
- name: reactions |
|
struct: |
|
- name: '+1' |
|
dtype: int64 |
|
- name: '-1' |
|
dtype: int64 |
|
- name: confused |
|
dtype: int64 |
|
- name: eyes |
|
dtype: int64 |
|
- name: heart |
|
dtype: int64 |
|
- name: hooray |
|
dtype: int64 |
|
- name: laugh |
|
dtype: int64 |
|
- name: rocket |
|
dtype: int64 |
|
- name: total_count |
|
dtype: int64 |
|
- name: url |
|
dtype: string |
|
- name: timeline_url |
|
dtype: string |
|
- name: performed_via_github_app |
|
dtype: float64 |
|
- name: state_reason |
|
dtype: string |
|
- name: draft |
|
dtype: float64 |
|
- name: pull_request |
|
struct: |
|
- name: diff_url |
|
dtype: string |
|
- name: html_url |
|
dtype: string |
|
- name: merged_at |
|
dtype: string |
|
- name: patch_url |
|
dtype: string |
|
- name: url |
|
dtype: string |
|
- name: is_pull_request |
|
dtype: bool |
|
splits: |
|
- name: train |
|
num_bytes: 3189923 |
|
num_examples: 500 |
|
download_size: 841717 |
|
dataset_size: 3189923 |
|
configs: |
|
- config_name: default |
|
data_files: |
|
- split: train |
|
path: data/train-* |
|
license: mit |
|
language: |
|
- en |
|
tags: |
|
- github |
|
- hf |
|
- datasets |
|
pretty_name: HF Datasets GitHub issues |
|
size_categories: |
|
- n<1K |
|
--- |
|
|
|
## Dataset Card for HF GitHub Dataset Issues with Comments |
|
|
|
### Table of Contents |
|
- [Dataset Description](#dataset-description) |
|
- [Dataset Summary](#dataset-summary) |
|
- [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards) |
|
- [Languages](#languages) |
|
- [Dataset Structure](#dataset-structure) |
|
- [Data Splits](#data-splits) |
|
- [Dataset Creation](#dataset-creation) |
|
- [Source Data](#source-data) |
|
- [Annotations](#annotations) |
|
- [Considerations for Using the Data](#considerations-for-using-the-data) |
|
- [Additional Information](#additional-information) |
|
|
|
--- |
|
|
|
### Dataset Description |
|
|
|
#### Dataset Summary |
|
This dataset consists of GitHub issues with their associated comments, providing insight into discussions and problem-solving processes in open-source development. Each issue entry includes metadata, such as issue title, description, labels, timestamps, and a series of comments with author information and timestamps. This dataset is valuable for studying code review, bug tracking, community dynamics, and language modeling tasks involving conversational threads. |
|
|
|
#### Supported Tasks and Leaderboards |
|
- **Text Classification**: Classify issues and comments by topic or label, e.g., "bug," "feature request." |
|
- **Sentiment Analysis**: Determine the sentiment of issue comments to gauge user satisfaction or frustration. |
|
- **Named Entity Recognition (NER)**: Identify technical terms, libraries, or code references within issue descriptions and comments. |
|
- **Summarization**: Generate summaries of discussions for quick context on complex threads. |
|
|
|
#### Languages |
|
Primarily **English (en)**, as GitHub is predominantly English-based, though some issues may contain multilingual comments. |
|
|
|
--- |
|
|
|
### Dataset Structure |
|
|
|
#### Data Fields |
|
- **issue_id**: Unique identifier for each GitHub issue. |
|
- **title**: The title of the GitHub issue. |
|
- **description**: Detailed description of the issue. |
|
- **labels**: Labels associated with the issue (e.g., bug, enhancement). |
|
- **created_at**: Timestamp when the issue was created. |
|
- **closed_at**: Timestamp when the issue was closed (if applicable). |
|
- **comments**: List of comments, each including: |
|
- **comment_id**: Unique identifier for each comment. |
|
- **comment_body**: Text content of the comment. |
|
- **comment_author**: Username of the comment author. |
|
- **comment_created_at**: Timestamp when the comment was created. |
|
|
|
#### Example |
|
``` |
|
{ |
|
"issue_id": "12345", |
|
"title": "Error when running setup", |
|
"description": "Steps to reproduce...", |
|
"labels": ["bug", "setup"], |
|
"created_at": "2022-08-01T12:34:56Z", |
|
"closed_at": null, |
|
"comments": [ |
|
{ |
|
"comment_id": "c1", |
|
"comment_body": "I faced the same issue...", |
|
"comment_author": "user123", |
|
"comment_created_at": "2022-08-01T13:00:00Z" |
|
}, |
|
... |
|
] |
|
} |
|
``` |
|
|
|
#### Data Splits |
|
This dataset may be split into **training**, **validation**, and **test** subsets based on issue ID, or by date ranges, to prevent data leakage between related issues or comments. |
|
|
|
--- |
|
|
|
### Dataset Creation |
|
|
|
#### Curation Rationale |
|
The dataset was created to support research and practical applications in software engineering, natural language processing, and community analysis. By aggregating issue discussions, we can better understand the collaborative problem-solving dynamics on GitHub. |
|
|
|
#### Source Data |
|
- **Source**: Data is sourced from public GitHub repositories. |
|
- **License**: Open data sourced from GitHub’s API under GitHub’s [terms of service](https://docs.github.com/en/github/site-policy/github-terms-of-service). |
|
|
|
#### Annotations |
|
- **Annotation Process**: No manual annotation; data fields are collected directly from GitHub issues and comments. |
|
- **Annotation Statistics**: Automatically gathered metadata (e.g., labels, timestamps, user comments). |
|
|
|
--- |
|
|
|
### Considerations for Using the Data |
|
|
|
#### Social Impact of Dataset |
|
This dataset aids in improving tools for open-source development and understanding community dynamics. However, comments may include sensitive discussions, which should be handled with privacy considerations. |
|
|
|
#### Dataset Limitations |
|
Some repositories may have data inconsistencies or missing fields, as issues and comments vary significantly in detail and style. |
|
|
|
#### Ethical Considerations |
|
Since comments are authored by individual users, avoid any misuse that could lead to user profiling or invasion of privacy. Consider GitHub’s data policies when redistributing or sharing this dataset. |
|
|
|
--- |
|
|
|
### Additional Information |
|
|
|
#### Citation |
|
Please cite this dataset as follows: |
|
``` |
|
@dataset{hf_github_issues_comments, |
|
title = {HF GitHub Dataset Issues with Comments}, |
|
author = {Raibek Tussupbekov}, |
|
year = {2024}, |
|
url = {https://huggingface.co/datasets/hf_github_issues_comments} |
|
} |
|
``` |
|
|
|
#### Contributions |
|
Data collection by Raibek Tussupbekov. Special thanks to contributors who maintain public GitHub repositories, making this dataset possible. |