Upload README.md with huggingface_hub
Browse files
README.md
ADDED
|
@@ -0,0 +1,47 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
---
|
| 2 |
+
license: cc-by-sa-4.0
|
| 3 |
+
language:
|
| 4 |
+
- en
|
| 5 |
+
pretty_name: GitHub Docs Corpus
|
| 6 |
+
size_categories:
|
| 7 |
+
- 1K<n<10K
|
| 8 |
+
task_categories:
|
| 9 |
+
- text-generation
|
| 10 |
+
tags:
|
| 11 |
+
- github
|
| 12 |
+
- documentation
|
| 13 |
+
- corpus
|
| 14 |
+
- sakthai
|
| 15 |
+
- house-of-sak
|
| 16 |
+
---
|
| 17 |
+
|
| 18 |
+
# GitHub Docs Corpus
|
| 19 |
+
|
| 20 |
+
A dataset containing **only information from GitHub** — the official
|
| 21 |
+
`github/docs` repository, i.e. the source of docs.github.com.
|
| 22 |
+
|
| 23 |
+
## Dataset Structure
|
| 24 |
+
|
| 25 |
+
- Files: `data/train.jsonl`
|
| 26 |
+
- Format: JSONL, one chunk per line
|
| 27 |
+
- Columns: `text` (cleaned doc chunk), `metadata` (`source`, `title`)
|
| 28 |
+
- Rows: 3,336
|
| 29 |
+
|
| 30 |
+
## Composition
|
| 31 |
+
|
| 32 |
+
- Source: `github/docs` (main branch), `content/` tree only — 3,734
|
| 33 |
+
Markdown files covering GitHub features, workflows, webhooks, REST/GraphQL
|
| 34 |
+
API docs, actions, security, and more.
|
| 35 |
+
- Processing: YAML frontmatter stripped (title kept), Liquid version tags
|
| 36 |
+
(`{% ifversion %}`), images and HTML comments removed, markdown links
|
| 37 |
+
flattened to their text, chunks split at heading boundaries (~2,000 chars).
|
| 38 |
+
- Excludes: files outside `content/`, assets, and pages with fewer than 40
|
| 39 |
+
chars of body text.
|
| 40 |
+
|
| 41 |
+
## Loading
|
| 42 |
+
|
| 43 |
+
```python
|
| 44 |
+
from datasets import load_dataset
|
| 45 |
+
|
| 46 |
+
ds = load_dataset("Nanthasit/github-docs", split="train")
|
| 47 |
+
```
|