You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Sep 9, 2025. It is now read-only.
[Docs] Update taxonomy docs to show PDF consumption (#1348)
**Description:** InstructLab 0.21.0 uses a version of SDG that allows
users to specify a PDF file they have in their git repository as a valid
document type. Updating taxonomy docs due to this update
Def would love feedback about how this should look from the taxonomy
perspective!
Signed-off-by: Kelly Brown <[email protected]>
Copy file name to clipboardExpand all lines: README.md
+7-4Lines changed: 7 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -256,8 +256,11 @@ Knowledge is supported by documents, such as a textbook, technical manual, encyc
256
256
257
257
Knowledge in the taxonomy tree consists of a few more elements than skills:
258
258
259
+
> [!IMPORTANT]
260
+
> If you are using InstructLab version `0.21.0` or above, you can specify PDF files in your knowledge `qna.yaml` file as a valid document type. Any previous version of InstructLab still only consumes knowledge documents in markdown format.
261
+
259
262
- Each knowledge node in the tree has a `qna.yaml`, similar to the format of the `qna.yaml` for skills.
260
-
- ⭐ Knowledge submissions require you to create a Git repository, can be with GitHub, that contains the markdown files of your knowledge contributions. These contributions in your repository must use the markdown (.md) format.
263
+
- ⭐ Knowledge submissions require you to create a Git repository, can be with GitHub, that contains the files of your knowledge contributions.
261
264
- The `qna.yaml` includes parameters that contain information from your repository.
262
265
263
266
> [!TIP]
@@ -279,9 +282,9 @@ The `qna.yaml` format must include the following fields:
279
282
-`answer`: Specify the desired answer from the model. Each `qna.yaml` file needs at least three question and answer pairs per `context` chunk with a maximum word count of 250 words.
280
283
-`document_outline`: Describe an overview of the document your submitting.
281
284
-`document`: The source of your knowledge contribution.
282
-
-`repo`: The URL to your repository that holds your knowledge markdown files.
283
-
-`commit`: The SHA of the commit in your repository with your knowledge markdown files.
284
-
-`patterns`: A list of glob patterns specifying the markdown files in your repository. Any glob pattern that starts with `*`, such as `*.md`, must be quoted due to YAML rules. For example, `"*.md"`.
285
+
-`repo`: The URL to your repository that holds your knowledge files.
286
+
-`commit`: The SHA of the commit in your repository with your knowledge files.
287
+
-`patterns`: A list of glob patterns specifying the files in your repository. Any glob pattern that starts with `*`, such as `*.md`, must be quoted due to YAML rules. For example, `"*.md"`.
0 commit comments