| --- |
| 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: login |
| dtype: string |
| - name: id |
| dtype: int64 |
| - name: node_id |
| dtype: string |
| - name: avatar_url |
| dtype: string |
| - name: gravatar_id |
| dtype: string |
| - name: url |
| dtype: string |
| - name: html_url |
| dtype: string |
| - name: followers_url |
| dtype: string |
| - name: following_url |
| dtype: string |
| - name: gists_url |
| dtype: string |
| - name: starred_url |
| dtype: string |
| - name: subscriptions_url |
| dtype: string |
| - name: organizations_url |
| dtype: string |
| - name: repos_url |
| dtype: string |
| - name: events_url |
| dtype: string |
| - name: received_events_url |
| dtype: string |
| - name: type |
| dtype: string |
| - name: user_view_type |
| dtype: string |
| - name: site_admin |
| dtype: bool |
| - name: labels |
| list: |
| - name: id |
| dtype: int64 |
| - name: node_id |
| dtype: string |
| - name: url |
| dtype: string |
| - name: name |
| dtype: string |
| - name: color |
| dtype: string |
| - name: default |
| dtype: bool |
| - name: description |
| dtype: string |
| - name: state |
| dtype: string |
| - name: locked |
| dtype: bool |
| - name: assignees |
| list: |
| - name: login |
| dtype: string |
| - name: id |
| dtype: int64 |
| - name: node_id |
| dtype: string |
| - name: avatar_url |
| dtype: string |
| - name: gravatar_id |
| dtype: string |
| - name: url |
| dtype: string |
| - name: html_url |
| dtype: string |
| - name: followers_url |
| dtype: string |
| - name: following_url |
| dtype: string |
| - name: gists_url |
| dtype: string |
| - name: starred_url |
| dtype: string |
| - name: subscriptions_url |
| dtype: string |
| - name: organizations_url |
| dtype: string |
| - name: repos_url |
| dtype: string |
| - name: events_url |
| dtype: string |
| - name: received_events_url |
| dtype: string |
| - name: type |
| dtype: string |
| - name: user_view_type |
| dtype: string |
| - name: site_admin |
| dtype: bool |
| - name: milestone |
| struct: |
| - name: url |
| dtype: string |
| - name: html_url |
| dtype: string |
| - name: labels_url |
| dtype: string |
| - name: id |
| dtype: int64 |
| - name: node_id |
| dtype: string |
| - name: number |
| dtype: int64 |
| - name: title |
| dtype: string |
| - name: description |
| dtype: string |
| - name: creator |
| struct: |
| - name: login |
| dtype: string |
| - name: id |
| dtype: int64 |
| - name: node_id |
| dtype: string |
| - name: avatar_url |
| dtype: string |
| - name: gravatar_id |
| dtype: string |
| - name: url |
| dtype: string |
| - name: html_url |
| dtype: string |
| - name: followers_url |
| dtype: string |
| - name: following_url |
| dtype: string |
| - name: gists_url |
| dtype: string |
| - name: starred_url |
| dtype: string |
| - name: subscriptions_url |
| dtype: string |
| - name: organizations_url |
| dtype: string |
| - name: repos_url |
| dtype: string |
| - name: events_url |
| dtype: string |
| - name: received_events_url |
| dtype: string |
| - name: type |
| dtype: string |
| - name: user_view_type |
| dtype: string |
| - name: site_admin |
| dtype: bool |
| - name: open_issues |
| dtype: int64 |
| - name: closed_issues |
| dtype: int64 |
| - name: state |
| dtype: string |
| - name: created_at |
| dtype: timestamp[s] |
| - name: updated_at |
| dtype: timestamp[s] |
| - name: due_on |
| dtype: 'null' |
| - name: closed_at |
| dtype: 'null' |
| - name: comments |
| list: string |
| - name: created_at |
| dtype: timestamp[s] |
| - name: updated_at |
| dtype: timestamp[s] |
| - name: closed_at |
| dtype: timestamp[s] |
| - name: assignee |
| struct: |
| - name: login |
| dtype: string |
| - name: id |
| dtype: int64 |
| - name: node_id |
| dtype: string |
| - name: avatar_url |
| dtype: string |
| - name: gravatar_id |
| dtype: string |
| - name: url |
| dtype: string |
| - name: html_url |
| dtype: string |
| - name: followers_url |
| dtype: string |
| - name: following_url |
| dtype: string |
| - name: gists_url |
| dtype: string |
| - name: starred_url |
| dtype: string |
| - name: subscriptions_url |
| dtype: string |
| - name: organizations_url |
| dtype: string |
| - name: repos_url |
| dtype: string |
| - name: events_url |
| dtype: string |
| - name: received_events_url |
| dtype: string |
| - name: type |
| dtype: string |
| - name: user_view_type |
| dtype: string |
| - name: site_admin |
| dtype: bool |
| - name: author_association |
| dtype: string |
| - name: issue_field_values |
| list: 'null' |
| - name: type |
| dtype: 'null' |
| - name: active_lock_reason |
| dtype: 'null' |
| - name: draft |
| dtype: bool |
| - name: pull_request |
| struct: |
| - name: url |
| dtype: string |
| - name: html_url |
| dtype: string |
| - name: diff_url |
| dtype: string |
| - name: patch_url |
| dtype: string |
| - name: merged_at |
| dtype: timestamp[s] |
| - name: body |
| dtype: string |
| - name: closed_by |
| struct: |
| - name: login |
| dtype: string |
| - name: id |
| dtype: int64 |
| - name: node_id |
| dtype: string |
| - name: avatar_url |
| dtype: string |
| - name: gravatar_id |
| dtype: string |
| - name: url |
| dtype: string |
| - name: html_url |
| dtype: string |
| - name: followers_url |
| dtype: string |
| - name: following_url |
| dtype: string |
| - name: gists_url |
| dtype: string |
| - name: starred_url |
| dtype: string |
| - name: subscriptions_url |
| dtype: string |
| - name: organizations_url |
| dtype: string |
| - name: repos_url |
| dtype: string |
| - name: events_url |
| dtype: string |
| - name: received_events_url |
| dtype: string |
| - name: type |
| dtype: string |
| - name: user_view_type |
| dtype: string |
| - name: site_admin |
| dtype: bool |
| - name: reactions |
| struct: |
| - name: url |
| dtype: string |
| - name: total_count |
| dtype: int64 |
| - name: '+1' |
| dtype: int64 |
| - name: '-1' |
| dtype: int64 |
| - name: laugh |
| dtype: int64 |
| - name: hooray |
| dtype: int64 |
| - name: confused |
| dtype: int64 |
| - name: heart |
| dtype: int64 |
| - name: rocket |
| dtype: int64 |
| - name: eyes |
| dtype: int64 |
| - name: timeline_url |
| dtype: string |
| - name: performed_via_github_app |
| dtype: 'null' |
| - name: state_reason |
| dtype: string |
| - name: sub_issues_summary |
| struct: |
| - name: total |
| dtype: int64 |
| - name: completed |
| dtype: int64 |
| - name: percent_completed |
| dtype: int64 |
| - name: issue_dependencies_summary |
| struct: |
| - name: blocked_by |
| dtype: int64 |
| - name: total_blocked_by |
| dtype: int64 |
| - name: blocking |
| dtype: int64 |
| - name: total_blocking |
| dtype: int64 |
| - name: pinned_comment |
| dtype: 'null' |
| - name: is_pull_request |
| dtype: bool |
| splits: |
| - name: train |
| num_bytes: 2210394 |
| num_examples: 500 |
| download_size: 1559931 |
| dataset_size: 2210394 |
| configs: |
| - config_name: default |
| data_files: |
| - split: train |
| path: data/train-* |
| tags: |
| - github |
| - issues |
| - nlp |
| - semantic-search |
| - github-user-problems |
| --- |
| |
| # GitHub Issues Dataset |
|
|
| ## Dataset Description |
|
|
| This dataset contains issues recorded from GitHub including pull requests collected from the Hugging Face datasets repository using the GitHub REST API. |
|
|
| This dataset was created to meet academic requirements with the following purposes in mind: |
| - data collection |
| - augmentation |
| - transformer pipelines |
| - semantic search using FAISS |
|
|
| --- |
|
|
| ## Data Collection |
|
|
| The data was collected by using GitHub REST API from the repository below: |
| - Repository: 'https://github.com/huggingface/datasets' |
|
|
| The following API endpoints were used: |
| - '/issues' |
| - `/issues/{issue_number}/comments` |
|
|
| 500 GitHub issues and pull requests were collected. |
|
|
| --- |
|
|
| ## Features in Dataset |
|
|
| Dataset contains: |
| - issue titles |
| - issue body text |
| - issue comments |
| - issue labels |
| - issue state |
| - timestamps |
| - pull request metadata |
|
|
| Additional engineered features include: |
| - `is_pull_request` |
| - `comments` |
|
|
| --- |
|
|
| ## Augmentation and Processing |
|
|
| The dataset was augmented by: |
|
|
| 1. Creating a boolean `is_pull_request` feature to distinguish issues from pull requests. |
|
|
| 2. Retrieving issue discussion comments using the GitHub comments API endpoint. |
|
|
| These augmentations improve contextual understanding and semantic retrieval capabilities. |
|
|
| --- |
|
|
| ## Intended Use |
|
|
| This dataset is intended for: |
| - NLP experimentation |
| - transformer inference |
| - semantic search |
| - educational purposes |
| - FAISS vector retrieval demonstrations |
|
|
| --- |
|
|
| ## Limitations |
|
|
| - Dataset only reflects a small portion of one GitHub repository |
| - Some issues may contain incomplete or noisy text |
| - API results may change over time |
| - Dataset may contain technical jargon and inconsistent formatting |
|
|
| --- |
|
|
| ## Risks |
|
|
| Although the data is publicly accessible, ethical considerations around secondary usage and user expectations remain relevant. |
| GitHub users may not expect their publicly available issue comments or repository discussions to be used for ML and semantic retrieval tasks. |
| The dataset may contain sensitive information unintentionally included by users, such as API keys, authentication tokens, email addresses, internal system details, or confidential technical information. |
| In future for greater security purposes, users could consider protecting API key by storing it in the OS environment for safer access. |
|
|
| --- |
|
|
| ## Licensing and Compliance Considerations |
|
|
| This dataset was created for educational and research purposes only. |
|
|
| The data was collected from GitHub Issue discussions which is publicly available and was done using GitHub REST API. |
|
|
| No private or confidential information was collected beyond publicly available metadata from GitHub. |
|
|
| Users of this dataset should comply with: |
| - GitHub's Terms of Service and API usage policies |
|
|
| Source content is attributable to the original GitHub contributors. |
|
|
| --- |
|
|
| GitHub Repository: |
| https://github.com/huggingface/datasets |
|
|
| GitHub REST API Documentation: |
| https://docs.github.com/en/rest |
