meeAtif commited on
Commit
6eec01b
·
verified ·
1 Parent(s): 76ac470

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +64 -69
README.md CHANGED
@@ -1,69 +1,64 @@
1
- ---
2
- language:
3
- - en
4
- license: cc-by-sa-4.0
5
- tags:
6
- - python
7
- - stackoverflow
8
- - question-answering
9
- - instruct
10
- size_categories:
11
- - 1K<n<10K
12
- ---
13
-
14
- # StackOverflow Python QA Dataset
15
-
16
- [![Status](https://img.shields.io/badge/Status-Active-success)](https://github.com/meeAtif)
17
- [![License](https://img.shields.io/badge/License-CC--BY--SA--4.0-lightgrey)](https://creativecommons.org/licenses/by-sa/4.0/)
18
-
19
- ## Description
20
-
21
- This dataset contains high-quality Python questions and answers scraped from StackOverflow. It is designed for instruct-tuning Large Language Models (LLMs) or for question-answering tasks.
22
-
23
- - **Source**: StackOverflow
24
- - **Selection Criteria**:
25
- - Tag: `python`
26
- - Score: > 10
27
- - Must have an **accepted answer**
28
- - **Content**: Pairs of instructions (Question) and outputs (Accepted Answer).
29
-
30
- ## Dataset Structure
31
-
32
- The dataset consists of the following fields:
33
-
34
- - `question_id`: The unique identifier for the question on StackOverflow.
35
- - `score`: The vote score of the question.
36
- - `tags`: A list of tags associated with the question.
37
- - `creation_date`: The timestamp of when the question was asked.
38
- - `instruction`: The full question title and body, cleaned of HTML.
39
- - `output`: The full body of the accepted answer, cleaned of HTML.
40
-
41
- ## Sample Entry
42
-
43
- ```json
44
- {
45
- "question_id": 12345,
46
- "score": 50,
47
- "tags": ["python", "list-comprehension"],
48
- "instruction": "How do I create a list... \n\n I have a loop that...",
49
- "output": "You can use a list comprehension:\n\n [x for x in iterable]"
50
- }
51
- ```
52
-
53
- ## Usage
54
-
55
- ```python
56
- from datasets import load_dataset
57
-
58
- dataset = load_dataset("meeAtif/stackoverflow-python-qa")
59
- print(dataset['train'][0])
60
- ```
61
-
62
- ## Author
63
-
64
- [![GitHub](https://img.shields.io/badge/GitHub-@meeAtif-181717?logo=github&logoColor=white)](https://github.com/meeAtif)
65
- [![LinkedIn](https://img.shields.io/badge/LinkedIn-@meAtif-0077B5?logo=linkedin&logoColor=white)](https://linkedin.com/in/meAtif)
66
- [![Email](https://img.shields.io/badge/Email-iatif@proton.me-D14836?logo=gmail&logoColor=white)](mailto:iatif@proton.me)
67
-
68
- ---
69
- *Created by [Atif](https://github.com/meeAtif)*
 
1
+ ---
2
+ language:
3
+ - en
4
+ license: cc-by-sa-4.0
5
+ tags:
6
+ - python
7
+ - stackoverflow
8
+ - question-answering
9
+ - instruct
10
+ size_categories:
11
+ - 1K<n<10K
12
+ ---
13
+
14
+ # StackOverflow Python QA Dataset
15
+
16
+ [![Status](https://img.shields.io/badge/Status-Active-success)](https://github.com/meeAtif)
17
+ [![License](https://img.shields.io/badge/License-CC--BY--SA--4.0-lightgrey)](https://creativecommons.org/licenses/by-sa/4.0/)
18
+
19
+ ## Description
20
+
21
+ This dataset contains high-quality Python questions and answers scraped from StackOverflow. It is designed for instruct-tuning Large Language Models (LLMs) or for question-answering tasks.
22
+
23
+ - **Source**: StackOverflow
24
+ - **Selection Criteria**:
25
+ - Tag: `python`
26
+ - Score: > 10
27
+ - Must have an **accepted answer**
28
+ - **Content**: Pairs of instructions (Question) and outputs (Accepted Answer).
29
+
30
+ ## Dataset Structure
31
+
32
+ The dataset consists of the following fields:
33
+
34
+ - `question_id`: The unique identifier for the question on StackOverflow.
35
+ - `score`: The vote score of the question.
36
+ - `tags`: A list of tags associated with the question.
37
+ - `creation_date`: The timestamp of when the question was asked.
38
+ - `instruction`: The full question title and body, cleaned of HTML.
39
+ - `output`: The full body of the accepted answer, cleaned of HTML.
40
+
41
+ ## Sample Entry
42
+
43
+ ```json
44
+ {
45
+ "question_id": 12345,
46
+ "score": 50,
47
+ "tags": ["python", "list-comprehension"],
48
+ "instruction": "How do I create a list... \n\n I have a loop that...",
49
+ "output": "You can use a list comprehension:\n\n [x for x in iterable]"
50
+ }
51
+ ```
52
+
53
+
54
+ ## Author
55
+
56
+
57
+ - **GitHub** [@meeAtif](https://github.com/meeAtif)
58
+ - **Linkedin** [@meAtif](https://www.linkedin.com/in/meatif/)
59
+ - **HuggingFace** [@meeAtif](https://huggingface.co/meeAtif)
60
+ - **Email:** iatif@proton.me
61
+ - **DM For:** Collaborations, Feedback, or Updates
62
+
63
+ ---
64
+ ---