Update README.md
Browse files
README.md
CHANGED
|
@@ -420,13 +420,54 @@ Key fields:
|
|
| 420 |
- Multilabel classification of issue labels
|
| 421 |
- Semantic search over issues
|
| 422 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 423 |
## Limitations
|
| 424 |
- A snapshot in time; newer issues are not included.
|
| 425 |
- (If you limited `num_issues`) Only a subset of all issues was collected.
|
| 426 |
- Text was written by GitHub users and may contain usernames, code, and links.
|
| 427 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 428 |
## License
|
| 429 |
Issue content belongs to the original GitHub authors and is subject to
|
| 430 |
[GitHub's Terms of Service](https://docs.github.com/en/site-policy/github-terms/github-terms-of-service).
|
| 431 |
|
| 432 |
-
Shared here for educational purposes.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 420 |
- Multilabel classification of issue labels
|
| 421 |
- Semantic search over issues
|
| 422 |
|
| 423 |
+
## Data Collection Process
|
| 424 |
+
1. **Authentication:** A read-only GitHub personal access token was stored in Kaggle Secret Key
|
| 425 |
+
, and loaded at runtime. It was never written into the notebook.
|
| 426 |
+
2. **Collection:** Issues and pull requests were requested from the GitHub REST API
|
| 427 |
+
using Python `requests`, page by page, staying within GitHub's rate limit of 5,000 requests per hour.
|
| 428 |
+
4. **Raw storage:** Responses were saved as a JSON Lines file (`datasets-issues.jsonl`).
|
| 429 |
+
5. **Loading:** The file was loaded with `datasets.load_dataset("json", ...)`.
|
| 430 |
+
6. **Cleaning:** 100 duplicate records (caused by a pagination error) were removed using
|
| 431 |
+
`number` as a unique key.
|
| 432 |
+
7. **Augmentation:** Derived fields were added (`is_pull_request`, [`days_to_close`, `label_names`]).
|
| 433 |
+
8. **Publishing:** The dataset was pushed to the Hugging Face Hub with `push_to_hub()`,
|
| 434 |
+
authenticated with a Hugging Face write token stored in Secret Keys.
|
| 435 |
+
|
| 436 |
## Limitations
|
| 437 |
- A snapshot in time; newer issues are not included.
|
| 438 |
- (If you limited `num_issues`) Only a subset of all issues was collected.
|
| 439 |
- Text was written by GitHub users and may contain usernames, code, and links.
|
| 440 |
|
| 441 |
+
## Legal and Policy Compliance
|
| 442 |
+
| Legislation / code / policy | How it applies | How this project complies |
|
| 443 |
+
|
| 444 |
+
| *Privacy Act 1988* (Cth) – Australian Privacy Principles | Usernames, profile links and free text may contain personal information
|
| 445 |
+
| Data limited to what is needed for the task; personal information is not used to profile individuals;|
|
| 446 |
+
|
| 447 |
+
| *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 |
|
| 448 |
+
| GitHub Terms of Service and API terms | Governs use of GitHub content and the API | Official API used, rate limits respected, source attributed |
|
| 449 |
+
|
| 450 |
+
| Hugging Face Content Policy | Governs what can be published on the Hub | Dataset contains public, non-sensitive technical discussion |
|
| 451 |
+
|
| 452 |
+
| North Metropolitan TAFE data storage and management policy |
|
| 453 |
+
|
| 454 |
## License
|
| 455 |
Issue content belongs to the original GitHub authors and is subject to
|
| 456 |
[GitHub's Terms of Service](https://docs.github.com/en/site-policy/github-terms/github-terms-of-service).
|
| 457 |
|
| 458 |
+
Shared here for educational purposes.
|
| 459 |
+
|
| 460 |
+
## References
|
| 461 |
+
- Gebru, T., Morgenstern, J., Vecchione, B., Vaughan, J. W., Wallach, H., Daumé III, H., & Crawford, K. (2021).
|
| 462 |
+
Datasheets for datasets. *Communications of the ACM, 64*(12), 86–92. https://doi.org/10.1145/3458723
|
| 463 |
+
- GitHub. (n.d.). *REST API endpoints for issues*. https://docs.github.com/en/rest/issues
|
| 464 |
+
- GitHub. (n.d.). *GitHub Terms of Service*. https://docs.github.com/en/site-policy/github-terms/github-terms-of-service
|
| 465 |
+
- huggingface/datasets GitHub repository. https://github.com/huggingface/datasets
|
| 466 |
+
- Hugging Face. (n.d.). *LLM Course*: Creating your own dataset (Ch. 5.5), Behind the pipeline (Ch. 2.2),
|
| 467 |
+
Semantic search with FAISS (Ch. 5.6). https://huggingface.co/learn/llm-course
|
| 468 |
+
- [Model used in Task 2, e.g. distilbert/distilbert-base-uncased-finetuned-sst-2-english]. Hugging Face.
|
| 469 |
+
- [Embedding model used in Task 3, e.g. sentence-transformers/multi-qa-mpnet-base-dot-v1]. Hugging Face.
|
| 470 |
+
- Office of the Australian Information Commissioner. (n.d.). *Australian Privacy Principles*.
|
| 471 |
+
https://www.oaic.gov.au/privacy/australian-privacy-principles
|
| 472 |
+
- *Copyright Act 1968* (Cth).
|
| 473 |
+
- North Metropolitan TAFE. [Title of the data storage/management policy on the LMS].
|