Color0106's picture
Update README.md
b611829 verified
|
Raw History Blame Contribute Delete
13.1 kB
---
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: archived_at
dtype: 'null'
- name: archived_by
dtype: 'null'
- 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: 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: float64
- name: created_at
dtype: timestamp[us]
- 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: float64
- 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: float64
- name: labels_url
dtype: string
- name: node_id
dtype: string
- name: number
dtype: float64
- name: open_issues
dtype: float64
- name: state
dtype: string
- name: title
dtype: string
- name: updated_at
dtype: timestamp[us]
- name: url
dtype: string
- name: comments
dtype: int64
- name: created_at
dtype: timestamp[s]
- name: updated_at
dtype: timestamp[s]
- name: closed_at
dtype: timestamp[s]
- 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: float64
- 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: author_association
dtype: string
- name: issue_field_values
sequence: 'null'
- name: type
dtype: 'null'
- name: active_lock_reason
dtype: 'null'
- name: draft
dtype: bool
- name: pull_request
struct:
- name: diff_url
dtype: string
- name: html_url
dtype: string
- name: merged_at
dtype: timestamp[us]
- name: patch_url
dtype: string
- name: url
dtype: string
- 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: float64
- 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: 'null'
- name: state_reason
dtype: string
- name: sub_issues_summary
struct:
- name: completed
dtype: float64
- name: percent_completed
dtype: float64
- name: total
dtype: float64
- name: issue_dependencies_summary
struct:
- name: blocked_by
dtype: float64
- name: blocking
dtype: float64
- name: total_blocked_by
dtype: float64
- name: total_blocking
dtype: float64
- name: pinned_comment
dtype: 'null'
- name: is_pull_request
dtype: bool
- name: days_to_close
dtype: float64
- name: label_names
sequence: string
splits:
- name: train
num_bytes: 19220900
num_examples: 4900
download_size: 4613131
dataset_size: 19220900
configs:
- config_name: default
data_files:
- split: train
path: data/train-*
license: other
task_categories:
- text-classification
- text-retrieval
language:
- en
tags:
- github-issues
- practice
pretty_name: GitHub Issues from huggingface/datasets
size_categories:
- 1K<n<10K
---
# GitHub Issues – huggingface/datasets (raw)
## Dataset Summary
A corpus of GitHub issues and pull requests from the
[JPEG XL support](https://github.com/huggingface/datasets/issues/8537) repository.
Created as a practice exercise following AT1-Task01 and Hugging Face LLM Course ("Creating your own dataset").
## How the data was collected
- Source: GitHub REST API (`/repos/huggingface/datasets/issues`, `state=all`)
- Collected on: 2026-10-05
- Pull requests are included; they can be identified by the `pull_request` field
(it is `None` for regular issues).
- This "raw" version keeps the original API fields with minimal processing
and does not include issue comments.
## Data Collection Process
1. **Authentication:** A read-only GitHub personal access token was stored in Kaggle Secret Key
, and loaded at runtime. It was never written into the notebook.
2. **Collection:** Issues and pull requests were requested from the GitHub REST API
using Python `requests`, page by page, staying within GitHub's rate limit of 5,000 requests per hour.
4. **Raw storage:** Responses were saved as a JSON Lines file.
5. **Loading:** The file was loaded with `datasets.load_dataset.
6. **Cleaning:** 100 duplicate records (caused by a pagination error) were removed using
`number` as a unique key.
7. **Augmentation:** Derived fields were added.
8. **Publishing:** The dataset was pushed to the Hugging Face Hub with `push_to_hub()`,
authenticated with a Hugging Face write token stored in Secret Keys.
## Dataset Structure
Each row is one issue or pull request.
Key fields:
- `number` – issue/PR number
- `title` – title
- `body` – description text
- `labels` – GitHub labels
- `state` – open or closed
- `created_at`, `closed_at` – timestamps
- `pull_request` – present only for pull requests
## Intended Uses
- Learning to build and share datasets with 🤗 Hugging Face Datasets
- Exploring how long issues take to close
- Multilabel classification of issue labels
- Semantic search over issues
## Storage, Locations and Versioning
| Item | Location | Versioning |
| Published dataset | https://huggingface.co/datasets/Color0106/github-raw | Hugging Face commit history (Files and versions → History) |
| Raw data | Collection date: [2026-10-05] |
| Notebook 1 – Collection & augmentation | [Kaggle Notebook] | [Ver 1 / 2026-10-05] |
| Notebook 2 – Transformers pipeline | [Colab Notebook] | [Ver 2 / 2026/10/18] |
| Notebook 3 – Semantic search (FAISS) | [Colab Notebook] | [Ver 1 / 2026/10/18] |
| Access tokens | Kaggle Secrets / Colab Secrets — not stored in any file | Expire on [2026/12/05] |
## Limitations
- A snapshot in time; newer issues are not included.
- Only a subset of all issues was collected.
- Text was written by GitHub users and may contain usernames, code, and links.
## Legal and Policy Compliance
| Legislation / code / policy | How it applies | How this project complies |
| *Privacy Act 1988* (Cth) – Australian Privacy Principles | Usernames, profile links and free text may contain personal information
| Data limited to what is needed for the task; personal information is not used to profile individuals;|
| *Copyright Act 1968* (Cth) | Issue text is written by GitHub users and is their work | No new licence is claimed; content is attributed and used for education |
| GitHub Terms of Service and API terms | Governs use of GitHub content and the API | Official API used, rate limits respected, source attributed |
| Hugging Face Content Policy | Governs what can be published on the Hub | Dataset contains public, non-sensitive technical discussion |
| North Metropolitan TAFE data storage and management policy |
## License
Issue content belongs to the original GitHub authors and is subject to
[GitHub's Terms of Service](https://docs.github.com/en/site-policy/github-terms/github-terms-of-service).
Shared here for educational purposes.
## References
- Gebru, T., Morgenstern, J., Vecchione, B., Vaughan, J. W., Wallach, H., Daumé III, H., & Crawford, K. (2021).
Datasheets for datasets. *Communications of the ACM, 64*(12), 86–92. https://doi.org/10.1145/3458723
- GitHub. (n.d.). *REST API endpoints for issues*. https://docs.github.com/en/rest/issues
- GitHub. (n.d.). *GitHub Terms of Service*. https://docs.github.com/en/site-policy/github-terms/github-terms-of-service
- huggingface/datasets GitHub repository. https://github.com/huggingface/datasets
- Hugging Face. (n.d.). *LLM Course*: Creating your own dataset (Ch. 5.5), Behind the pipeline (Ch. 2.2),
Semantic search with FAISS (Ch. 5.6). https://huggingface.co/learn/llm-course
- [Model used in Task 2, e.g. distilbert/distilbert-base-uncased-finetuned-sst-2-english]. Hugging Face.
- [Embedding model used in Task 3, e.g. sentence-transformers/multi-qa-mpnet-base-dot-v1]. Hugging Face.
- Office of the Australian Information Commissioner. (n.d.). *Australian Privacy Principles*.
https://www.oaic.gov.au/privacy/australian-privacy-principles
- *Copyright Act 1968* (Cth).