koutch commited on
Commit
a451d08
·
1 Parent(s): 29e7bb4

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +20 -13
README.md CHANGED
@@ -40,18 +40,28 @@ However, users can ask a wide range of questions on stackoverflow; The "stackove
40
  posted on SO with an associated type. Following a previous [study](https://ieeexplore.ieee.org/document/6405249), each question was annotated with a type
41
  capturing the main concern of the user who posted the question. The questions were annotated with the given types:
42
 
43
- * *How to do it*: Providing a scenario and asking about how to implement it (sometimes with a given technology or API).
44
- * *Debug/corrective*: Dealing with problems in the code under development, such as runtime errors and unexpected behaviour.
45
- * *Seeking different solutions*: The questioner has a working code yet is seeking a different approach to doing the job.
46
  * *Need to know*: Questions regarding the possibility or availability of (doing) something. These questions normally show the lack of knowledge or uncertainty about some aspects of the technology (e.g. the presence of a feature in an API or a language).
47
- * *Other*: Something else
 
 
 
 
 
48
 
49
- We note the following distinction between the three first categories.
 
 
 
50
 
51
- - How to do it: the user wants to do "x", has no clear idea or solution/doesn't know how to do it -> wants any solution for solving "x".
52
- - Debug: the user wants to do "x", has a clear idea/solution "y" but it is not working, and is seeking a correction to "y".
53
- - Seeking-different-solution: the user wants to do "x", and found already a working solution "y", but is seeking an alternative "z".
54
 
 
 
 
 
 
 
 
55
  Naturally, some questions may have multiple concerns (i.e. could correspond to multiple categories).
56
  However, this dataset contains mainly questions for which we could assign a clear single category to each question.
57
  Currently, all questions annotated are a subset of the [stackoverflow_python](koutch/stackoverflow_python) dataset.
@@ -71,10 +81,10 @@ The currently annotated questions concern posts with the *python* tag. The quest
71
  - question_id: the unique id of the post
72
  - question_body: the (HTML) content of the question
73
  - question_type: the assigned category/type/label
 
74
  - "howto",
75
  - "debug",
76
  - "seeking",
77
- - "conceptual",
78
  - "other"
79
 
80
  ### Data Splits
@@ -91,7 +101,7 @@ The currently annotated questions concern posts with the *python* tag. The quest
91
  Previous research looked into mining natural language-code pairs from stackoverflow.
92
  Two notable works yielded the [StaQC](https://arxiv.org/abs/1803.09371) and [ConaLA](https://arxiv.org/abs/1803.09371) datasets.
93
  Parts of the dataset used a subset of the manual annotations provided by the authors of the papers (available at [staqc](https://huggingface.co/datasets/koutch/staqc),
94
- and [conala](https://huggingface.co/datasets/neulab/conala]). The questions were annotated as belonging to the "how to do it" category.
95
 
96
  To ease the annotation procedure, we used the [argilla platform](https://docs.argilla.io/en/latest/index.html)
97
  and multiple iterations of [few-shot training with a SetFit model](https://docs.argilla.io/en/latest/tutorials/notebooks/labelling-textclassification-setfit-zeroshot.html#%F0%9F%A6%BE-Train-a-few-shot-SetFit-model).
@@ -105,6 +115,3 @@ and multiple iterations of [few-shot training with a SetFit model](https://docs.
105
  ### Other Known Limitations
106
 
107
  [More Information Needed]
108
- # Dataset Card for "stackoverflow_question_types"
109
-
110
- [More Information needed](https://github.com/huggingface/datasets/blob/main/CONTRIBUTING.md#how-to-contribute-to-the-dataset-cards)
 
40
  posted on SO with an associated type. Following a previous [study](https://ieeexplore.ieee.org/document/6405249), each question was annotated with a type
41
  capturing the main concern of the user who posted the question. The questions were annotated with the given types:
42
 
 
 
 
43
  * *Need to know*: Questions regarding the possibility or availability of (doing) something. These questions normally show the lack of knowledge or uncertainty about some aspects of the technology (e.g. the presence of a feature in an API or a language).
44
+ * *How to do it*: Providing a scenario and asking how to implement it (sometimes with a given technology or API).
45
+ * *Debug/corrective*: Dealing with problems in the code under development, such as runtime errors and unexpected behaviour.
46
+ * *Seeking different solutions*: The questioner has a working code yet seeks a different approach to doing the job.
47
+ * *Other*: a question related to another aspect of programming, or even non-related to programming.
48
+
49
+ ### Remarks
50
 
51
+ For this dataset, we are mainly interested in questions related to *programming*.
52
+ For instance, for [this question](https://stackoverflow.com/questions/51142399/no-acceptable-c-compiler-found-in-path-installing-python-and-gcc),
53
+ the user is "trying to install Python-3.6.5 on a machine that does not have any package manager installed" and is facing issues.
54
+ Because it's not related to the concept of programming, we would classify it as "other" and not "debugging".
55
 
56
+ Moreover, we note the following conceptual distinctions between the different categories:
 
 
57
 
58
+ - Need to know: the user asks "is it possible to do x"
59
+ - How to do it: the user wants to do "x", knows it's possible, but has no clear idea or solution/doesn't know how to do it -> wants any solution for solving "x".
60
+ - Debug: the user wants to do "x", and has a clear idea/solution "y" but it is not working, and is seeking a correction to "y".
61
+ - Seeking-different-solution: the user wants to do "x", and has found already a working solution "y", but is seeking an alternative "z".
62
+
63
+ Sometimes, it's hard to truly understand the users' true intentions;
64
+ the separating line between each category will be minor and might be subject to interpretation.
65
  Naturally, some questions may have multiple concerns (i.e. could correspond to multiple categories).
66
  However, this dataset contains mainly questions for which we could assign a clear single category to each question.
67
  Currently, all questions annotated are a subset of the [stackoverflow_python](koutch/stackoverflow_python) dataset.
 
81
  - question_id: the unique id of the post
82
  - question_body: the (HTML) content of the question
83
  - question_type: the assigned category/type/label
84
+ - "needtoknow"
85
  - "howto",
86
  - "debug",
87
  - "seeking",
 
88
  - "other"
89
 
90
  ### Data Splits
 
101
  Previous research looked into mining natural language-code pairs from stackoverflow.
102
  Two notable works yielded the [StaQC](https://arxiv.org/abs/1803.09371) and [ConaLA](https://arxiv.org/abs/1803.09371) datasets.
103
  Parts of the dataset used a subset of the manual annotations provided by the authors of the papers (available at [staqc](https://huggingface.co/datasets/koutch/staqc),
104
+ and [conala](https://huggingface.co/datasets/neulab/conala])). The questions were annotated as belonging to the "how to do it" category.
105
 
106
  To ease the annotation procedure, we used the [argilla platform](https://docs.argilla.io/en/latest/index.html)
107
  and multiple iterations of [few-shot training with a SetFit model](https://docs.argilla.io/en/latest/tutorials/notebooks/labelling-textclassification-setfit-zeroshot.html#%F0%9F%A6%BE-Train-a-few-shot-SetFit-model).
 
115
  ### Other Known Limitations
116
 
117
  [More Information Needed]