Add dataset card (README)
Browse files
README.md
ADDED
|
@@ -0,0 +1,142 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
pretty_name: GitHub Scikit-learn Issues Dataset
|
| 3 |
+
language:
|
| 4 |
+
- en
|
| 5 |
+
license: other
|
| 6 |
+
size_categories:
|
| 7 |
+
- n<1K
|
| 8 |
+
task_categories:
|
| 9 |
+
- text-classification
|
| 10 |
+
- sentence-similarity
|
| 11 |
+
tags:
|
| 12 |
+
- github
|
| 13 |
+
- scikit-learn
|
| 14 |
+
- issue-tracking
|
| 15 |
+
- software-engineering
|
| 16 |
+
- open-data
|
| 17 |
+
- text
|
| 18 |
+
---
|
| 19 |
+
|
| 20 |
+
# GitHub Scikit-learn Issues Dataset
|
| 21 |
+
|
| 22 |
+
## 1. Overview
|
| 23 |
+
|
| 24 |
+
This dataset contains 300 issues collected from the public GitHub repository
|
| 25 |
+
[scikit-learn/scikit-learn](https://github.com/scikit-learn/scikit-learn). It was created for an
|
| 26 |
+
AI/data assessment (Weeks 9-12) to demonstrate dataset creation, a Transformers pipeline and
|
| 27 |
+
FAISS semantic search, with documentation of sourcing, limitations and compliance.
|
| 28 |
+
|
| 29 |
+
- Dataset: https://huggingface.co/datasets/BeNatural/github-scikit-learn-issues-dataset
|
| 30 |
+
- Source: https://github.com/scikit-learn/scikit-learn/issues
|
| 31 |
+
- Format: Parquet, one `train` split, 300 rows, 14 columns
|
| 32 |
+
|
| 33 |
+
## 2. Why this dataset
|
| 34 |
+
|
| 35 |
+
GitHub issues are real, human-written technical text (bug reports, feature requests, documentation
|
| 36 |
+
problems) paired with structured metadata (labels, dates, state, comment counts). This makes them
|
| 37 |
+
suitable for text classification, sentiment/zero-shot analysis and semantic search for similar
|
| 38 |
+
issues, and the scikit-learn project is well known, openly developed and well documented.
|
| 39 |
+
|
| 40 |
+
## 3. Data collection
|
| 41 |
+
|
| 42 |
+
- Platform: GitHub (public issues of `scikit-learn/scikit-learn`)
|
| 43 |
+
- Collection method: issues were retrieved from the GitHub REST API (`https://api.github.com/repos/scikit-learn/scikit-learn/issues`) using Python and the `requests` library, then assembled into a pandas DataFrame, saved as CSV and published to the Hugging Face Hub in Parquet format.
|
| 44 |
+
- Collection date: 12 October 2026
|
| 45 |
+
- Authentication: requests were authenticated with a GitHub personal access token. The token is not included in this dataset or repository.
|
| 46 |
+
- Scope: the dataset contains issues only. No pull requests are included (no record has a `/pull/` URL).
|
| 47 |
+
- Selection: the 300 records are the **oldest** issues in the repository (issue numbers 1 to 768, created between 2010-08-31 and 2012-04-13). They are not a random sample.
|
| 48 |
+
|
| 49 |
+
## 4. Dataset structure
|
| 50 |
+
|
| 51 |
+
| Column | Type | Description |
|
| 52 |
+
|---|---|---|
|
| 53 |
+
| `issue_id` | int | GitHub's global issue ID |
|
| 54 |
+
| `issue_number` | int | Issue number within the repository |
|
| 55 |
+
| `repository` | string | `scikit-learn/scikit-learn` |
|
| 56 |
+
| `title` | string | Issue title |
|
| 57 |
+
| `body` | string | Issue description (9 records are empty) |
|
| 58 |
+
| `state` | string | `closed` (295) or `open` (5) |
|
| 59 |
+
| `labels` | string | Comma-separated GitHub labels (empty for 235 records) |
|
| 60 |
+
| `created_at` | datetime | When the issue was opened (UTC) |
|
| 61 |
+
| `closed_at` | datetime | When the issue was closed (empty for open issues) |
|
| 62 |
+
| `comments` | int | Number of comments on the issue (count only; comment text is not included) |
|
| 63 |
+
| `author` | string | Public GitHub username of the issue author |
|
| 64 |
+
| `html_url` | string | Link to the original issue |
|
| 65 |
+
| `text_length` | int | Derived field: length of the issue text (see Section 5) |
|
| 66 |
+
| `time_to_close_hours` | float | Derived field: hours between `created_at` and `closed_at` (empty for open issues) |
|
| 67 |
+
|
| 68 |
+
## 5. Processing and augmentation
|
| 69 |
+
|
| 70 |
+
- Raw issue records were assembled into a structured table (one row per issue).
|
| 71 |
+
- Pull requests were excluded so that only issues remain.
|
| 72 |
+
- Duplicates: none found (all `issue_id`, `issue_number` and `html_url` values are unique).
|
| 73 |
+
- Derived fields added: `text_length` and `time_to_close_hours`.
|
| 74 |
+
- Missing values were **kept, not imputed**: 9 empty bodies, 235 records without labels, and 5 open issues without `closed_at` / `time_to_close_hours`.
|
| 75 |
+
|
| 76 |
+
## 6. Initial data summary
|
| 77 |
+
|
| 78 |
+
| Item | Value |
|
| 79 |
+
|---|---|
|
| 80 |
+
| Rows / columns | 300 / 14 |
|
| 81 |
+
| Date range | 2010-08-31 to 2012-04-13 |
|
| 82 |
+
| State | 295 closed, 5 open |
|
| 83 |
+
| Issues with labels | 65 of 300 (22%) |
|
| 84 |
+
| Most common labels | New Feature (21), Enhancement (11), Bug (7) |
|
| 85 |
+
| Comments per issue | median 4, mean 7.2, max 59 |
|
| 86 |
+
| Time to close | median about 1,195 hours (about 50 days); highly skewed (max about 125,700 hours) |
|
| 87 |
+
| Distinct authors | 84; the top 3 (amueller, fabianp, mblondel) wrote 132 of the 300 issues |
|
| 88 |
+
|
| 89 |
+
## 7. Intended uses
|
| 90 |
+
|
| 91 |
+
1. **Transformers pipeline:** apply a pretrained model (e.g. sentiment or zero-shot classification) to titles/bodies and examine the outputs.
|
| 92 |
+
2. **Semantic search:** embed issue text and build a FAISS index to retrieve similar issues for natural-language queries.
|
| 93 |
+
|
| 94 |
+
Not intended for: profiling individual contributors, or drawing conclusions about the modern scikit-learn project.
|
| 95 |
+
|
| 96 |
+
## 8. Limitations and bias
|
| 97 |
+
|
| 98 |
+
- **Temporal bias:** all issues are from 2010-2012, the earliest days of the project. Topics, labels and writing style differ from current issues, and many early issues were written by a handful of core developers.
|
| 99 |
+
- **Small sample:** 300 rows, not representative of the repository's full history.
|
| 100 |
+
- **Author concentration:** a few authors account for a large share of records.
|
| 101 |
+
- **Sparse labels:** 78% of issues have no label, so label-based analysis covers a minority.
|
| 102 |
+
- **Short or empty text:** some bodies are empty or very short, which weakens classification and embedding quality.
|
| 103 |
+
- **Open vs closed:** only 5 issues are open, so resolution-time analysis is dominated by closed issues.
|
| 104 |
+
- **Model limitations:** general-purpose sentiment models often misread technical text; semantic search quality depends on the embedding model.
|
| 105 |
+
- **No comment text:** only the number of comments is included.
|
| 106 |
+
|
| 107 |
+
## 9. Ethics, legal and compliance
|
| 108 |
+
|
| 109 |
+
- **Privacy:** issues are public, but they include public GitHub usernames and can contain links or occasional email-like text. Usernames have been kept as they appear publicly on GitHub. The dataset is not used to identify or profile individuals.
|
| 110 |
+
- **Attribution:** content originates from the scikit-learn GitHub project and its contributors; every record links back to its original issue via `html_url`.
|
| 111 |
+
- **Licensing:** the scikit-learn software is BSD-3-Clause. This licence is for the software repository and is not assumed to cover user-written issue text, so this dataset is marked `license: other` and is shared for educational and research purposes only. Users should check GitHub's Terms of Service and the original project's terms before reuse.
|
| 112 |
+
- **Terms of service:** data was collected from publicly available content through the official GitHub API.
|
| 113 |
+
- **Organisational policy alignment:** the dataset was collected, stored and documented in line with the organisation's data storage, management and compliance policies provided for this assessment: public source data only, no private data, attribution to the original source, secure handling of credentials, and versioned storage.
|
| 114 |
+
- **Security:** API tokens are not stored in the notebooks or this repository.
|
| 115 |
+
|
| 116 |
+
## 10. Risks and corrective actions
|
| 117 |
+
|
| 118 |
+
| Risk | Mitigation |
|
| 119 |
+
|---|---|
|
| 120 |
+
| Personal data in public issue text | Keep only public handles; document handling; remove or anonymise `author` if required; do not target individuals |
|
| 121 |
+
| Temporal / sampling bias | Document the 2010-2012 window; in future, collect a random or time-stratified sample |
|
| 122 |
+
| Licence ambiguity of user content | Mark as `other`, link back to originals, educational use only |
|
| 123 |
+
| Missing labels / bodies | Keep missing values visible, report counts, avoid over-interpreting |
|
| 124 |
+
| Misleading model output | Manually review sample predictions and state model limits |
|
| 125 |
+
| Data loss | Dataset on the Hugging Face Hub with version history; notebooks and outputs backed up per policy |
|
| 126 |
+
|
| 127 |
+
## 11. Storage, versioning and reproducibility
|
| 128 |
+
|
| 129 |
+
- Published on the Hugging Face Hub (git-based, so every commit is versioned): https://huggingface.co/datasets/BeNatural/github-scikit-learn-issues-dataset
|
| 130 |
+
- Notebooks: three notebooks (data collection and augmentation, Transformers pipeline, FAISS semantic search) are submitted with this assessment as evidence.
|
| 131 |
+
- Local copy: the CSV and notebooks are kept as a backup copy alongside the project files.
|
| 132 |
+
- Version: v1.0, collected 12 October 2026. Any later changes to the data or processing should be recorded here.
|
| 133 |
+
|
| 134 |
+
## 12. References
|
| 135 |
+
|
| 136 |
+
- scikit-learn repository: https://github.com/scikit-learn/scikit-learn
|
| 137 |
+
- scikit-learn issues: https://github.com/scikit-learn/scikit-learn/issues
|
| 138 |
+
- GitHub REST API (issues): https://docs.github.com/en/rest/issues
|
| 139 |
+
- Hugging Face LLM Course, Creating your own dataset: https://huggingface.co/learn/llm-course/chapter5/5?fw=pt
|
| 140 |
+
- Hugging Face LLM Course, Behind the pipeline: https://huggingface.co/learn/llm-course/chapter2/2?fw=pt
|
| 141 |
+
- Hugging Face LLM Course, Semantic search with FAISS: https://huggingface.co/learn/llm-course/chapter5/6?fw=pt
|
| 142 |
+
- Datasheets for Datasets (Gebru et al.): https://arxiv.org/abs/1803.09010
|