Added taxonomy template (#1291)

Sometimes it's nice to have everything templated out to start with. --------- Signed-off-by: JJ Asghar <[email protected]> Co-authored-by: BJ Hargrave <[email protected]>
instructlab · Sep 6, 2024 · 8459321 · 8459321
1 parent a85e727
commit 8459321
Showing 1 changed file with 52 additions and 0 deletions.
diff --git a/docs/template_qna.yaml b/docs/template_qna.yaml
@@ -0,0 +1,52 @@
+version: 3
+domain: <The knowledge domain which is used in prompts to the teacher model during synthetic data generation. The domain should be brief such as the title to a textbook chapter or section.>
+created_by: <The GitHub username of the contributor.>
+seed_examples:
+  - context: |
+    <Context from the document associated with this set of sample q&a pairs.>
+    questions_and_answers:
+      - question: |
+        <A question used for synthetic data generation. Based upon the previous context.>
+        answer: |
+          <The desired response for the question. Based upon the previous context.>
+      - question: |
+        answer: |
+      - question: |
+        answer: |
+  - context: |
+    questions_and_answers:
+      - question: |
+        answer: |
+      - question: |
+        answer: |
+      - question: |
+        answer: |
+  - context: |
+    questions_and_answers:
+      - question:
+        answer: |
+      - question: |
+        answer: |
+      - question: |
+        answer: |
+  - context: |
+      - question: |
+        answer: |
+      - question: |
+        answer: |
+  - context: |
+    questions_and_answers:
+      - question: |
+        answer: |
+      - question: |
+        answer: |
+      - question: |
+        answer: |
+document_outline: |
+  <A brief summary of the document.>
+document:
+  repo: https://github.com/<username>/<repo>.git
+  commit: <full commit SHA>
+  patterns:
+    - <FILENAME>.md
+