MagnumAI commited on
Commit
4fbc87f
·
verified ·
1 Parent(s): a4a7d7c

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +198 -0
README.md CHANGED
@@ -1,3 +1,201 @@
1
  ---
2
  license: apache-2.0
 
 
 
 
 
 
 
 
 
3
  ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  license: apache-2.0
3
+ language:
4
+ - en
5
+ tags:
6
+ - qa
7
+ - questionanswer
8
+ - response
9
+ - chat
10
+ - llm
11
+ pretty_name: MyQA
12
  ---
13
+
14
+ # MagnumAI/MyQA
15
+
16
+ A compact conversational **prompt → response** dataset for experimenting with instruction following, supervised fine-tuning (SFT), and general-purpose conversational behavior.
17
+
18
+ The dataset contains natural-language prompts ranging from simple greetings and factual questions to everyday advice, explanations, how-to questions, and casual conversation.
19
+
20
+ ## Dataset Overview
21
+
22
+ **Dataset:** `MagnumAI/MyQA`
23
+ **Format:** JSONL
24
+ **Fields:** `prompt`, `response`
25
+ **Approximate size:** 300 KB
26
+ **Task:** Conversational question answering / instruction following
27
+
28
+ Each record consists of a user-style prompt paired with an assistant response:
29
+
30
+ ```json
31
+ {"prompt": "hey", "response": "Hey! 😊 What's up?"}
32
+ ```
33
+
34
+ ## What's Inside?
35
+
36
+ The dataset covers a range of everyday conversational patterns, including:
37
+
38
+ * Greetings and small talk
39
+ * General questions
40
+ * Geography and general knowledge
41
+ * Cooking and food
42
+ * Practical how-to questions
43
+ * Hobbies and learning
44
+ * Games and skill development
45
+ * Animal behavior
46
+ * Language and grammar
47
+ * Productivity and habits
48
+ * Entertainment recommendations
49
+ * Philosophical questions
50
+ * Casual conversation
51
+
52
+ Responses generally aim to be:
53
+
54
+ * Helpful and conversational
55
+ * Direct without being overly terse
56
+ * Structured when an explanation benefits from it
57
+ * Friendly and approachable
58
+ * Honest about uncertainty
59
+ * Actionable for practical questions
60
+
61
+ Longer responses commonly use Markdown headings, bullet points, numbered steps, and follow-up suggestions.
62
+
63
+ ## Format
64
+
65
+ The dataset is stored as **JSON Lines (JSONL)**, with one example per line.
66
+
67
+ ### Schema
68
+
69
+ | Field | Type | Description |
70
+ | ---------- | -------- | --------------------------------------------- |
71
+ | `prompt` | `string` | The user's question or conversational message |
72
+ | `response` | `string` | The corresponding assistant response |
73
+
74
+ Example:
75
+
76
+ ```json
77
+ {"prompt": "what's the capital of Australia?", "response": "Canberra! 🇦🇺 Not Sydney or Melbourne — those are the two people usually guess."}
78
+ ```
79
+
80
+ Longer responses may contain escaped newlines:
81
+
82
+ ```json
83
+ {
84
+ "prompt": "how do I boil an egg?",
85
+ "response": "Easy one — here's the reliable method.\n## The Steps\n1. Place eggs in a pot and cover with cold water..."
86
+ }
87
+ ```
88
+
89
+ ## Intended Uses
90
+
91
+ `MagnumAI/MyQA` can be used for:
92
+
93
+ * Supervised fine-tuning experiments
94
+ * Instruction-following experiments
95
+ * Conversational model prototyping
96
+ * Testing prompt/response formatting
97
+ * Small-scale chatbot experiments
98
+ * Studying conversational response styles
99
+ * Dataset preprocessing and JSONL pipeline testing
100
+
101
+ A typical training example can be converted into the format expected by your model or training framework:
102
+
103
+ ```python
104
+ {
105
+ "messages": [
106
+ {"role": "user", "content": example["prompt"]},
107
+ {"role": "assistant", "content": example["response"]}
108
+ ]
109
+ }
110
+ ```
111
+
112
+ ## Limitations
113
+
114
+ This is a relatively small dataset and **should not be treated as a comprehensive knowledge or safety benchmark**.
115
+
116
+ In particular:
117
+
118
+ * The dataset is not designed to provide exhaustive factual coverage.
119
+ * Some responses contain recommendations or subjective advice.
120
+ * General-knowledge answers may become outdated over time.
121
+ * Practical advice may require additional context.
122
+ * The dataset does not provide a comprehensive evaluation of model safety.
123
+ * The examples primarily represent everyday conversational interactions rather than adversarial or safety-critical prompts.
124
+ * A model trained on this dataset may learn its particular tone, formatting habits, and response patterns.
125
+
126
+ Models fine-tuned on this dataset should be evaluated independently rather than assuming dataset quality guarantees model quality.
127
+
128
+ ## Example
129
+
130
+ **Prompt**
131
+
132
+ > how do I stop procrastinating?
133
+
134
+ **Response**
135
+
136
+ > Procrastination is usually less about laziness and more about avoiding discomfort — boredom, anxiety, ambiguity, whatever the task stirs up. So the fix isn't willpower, it's lowering the friction.
137
+ >
138
+ > ## Start Smaller Than Feels Reasonable
139
+ >
140
+ > "Write the report" is too big. "Open the doc and write one sentence" is doable. The goal is to get past the starting point, because momentum often handles the rest.
141
+ >
142
+ > ...
143
+
144
+ This illustrates the dataset's general preference for **conversational explanations combined with structured, practical advice**.
145
+
146
+ ## Fine-Tuning
147
+
148
+ For a chat-oriented model, examples can be represented as:
149
+
150
+ ```json
151
+ {
152
+ "messages": [
153
+ {
154
+ "role": "user",
155
+ "content": "what's the capital of Canada?"
156
+ },
157
+ {
158
+ "role": "assistant",
159
+ "content": "Ottawa! 🇨🇦 Toronto and Vancouver get guessed more often, but Ottawa's the one."
160
+ }
161
+ ]
162
+ }
163
+ ```
164
+
165
+ The exact formatting should be adapted to the chat template expected by the base model.
166
+
167
+ ## Dataset Characteristics
168
+
169
+ | Characteristic | Description |
170
+ | ---------------- | ------------------------------------ |
171
+ | Data type | Conversational QA |
172
+ | Input | Natural-language prompts |
173
+ | Output | Assistant responses |
174
+ | Storage | JSONL |
175
+ | Size | ~300 KB |
176
+ | Style | Friendly, conversational, structured |
177
+ | Primary language | English |
178
+ | Intended setting | General-purpose conversational AI |
179
+
180
+ ## License
181
+
182
+ See the repository's Hugging Face dataset metadata for the applicable license.
183
+
184
+ If you are redistributing, modifying, or using the dataset commercially, verify that the license and provenance of the underlying examples permit your intended use.
185
+
186
+ ## Contributions
187
+
188
+ Suggestions, corrections, additional examples, and improvements to the dataset are welcome.
189
+
190
+ When contributing examples, prefer:
191
+
192
+ * Clear prompts
193
+ * Useful, self-contained responses
194
+ * Accurate information
195
+ * Natural conversational language
196
+ * Consistent formatting
197
+ * No unnecessary personal or sensitive information
198
+
199
+ ## Acknowledgements
200
+
201
+ Created and maintained by **MagnumAI**.