Update URLs to point to the new URLs for test-data files

The repo structure was modified in `instructlab/instructlab`, so we need to update the URLs to coincide with that change. Also, we need to add `mbta` to the spellcheck dictionary because the PR build checks think that `mbta` is a misspelled word. Signed-off-by: Courtney Pacheco <[email protected]>
instructlab · Dec 11, 2024 · 6397b6e · 6397b6e
1 parent 31ff971
commit 6397b6e
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 4 deletions.
diff --git a/.spellcheck-en-custom.txt b/.spellcheck-en-custom.txt
@@ -5,8 +5,8 @@ Backport
 backported
 CLI
 codebase
-composable
 Composable
+composable
 config
 configs
 customizable
@@ -29,6 +29,7 @@ JSON
 Langchain's
 LLM
 LLMBlock
+mbta
 MCQ
 Merlinite
 Mixtral

diff --git a/docs/dataset_formats.md b/docs/dataset_formats.md
@@ -48,9 +48,17 @@ The fields in a knowledge contribution are:
 
 Examples of these files used in CI are found [here](https://github.com/instructlab/instructlab/tree/main/scripts/test-data):
 
-* [e2e-qna-freeform-skill](https://github.com/instructlab/instructlab/blob/main/scripts/test-data/e2e-qna-freeform-skill.yaml)
-* [e2e-qna-grounded-skill](https://github.com/instructlab/instructlab/blob/main/scripts/test-data/e2e-qna-grounded-skill.yaml)
-* [e2e-qna-knowledge](https://github.com/instructlab/instructlab/blob/main/scripts/test-data/e2e-qna-knowledge.yaml)
+* Compositional skills
+  * Freeform
+    * [e2e-qna-freeform-palindrome-skill](https://github.com/instructlab/instructlab/blob/main/scripts/test-data/compositional_skills/freeform/e2e-qna-freeform-palindrome-skill.yaml)
+    * [e2e-qna-freeform-siblings-skill](https://github.com/instructlab/instructlab/blob/main/scripts/test-data/compositional_skills/freeform/e2e-qna-freeform-siblings-skill.yaml)
+  * Grounded
+    * [e2e-qna-grounded-employee-skill](https://github.com/instructlab/instructlab/blob/main/scripts/test-data/compositional_skills/grounded/e2e-qna-grounded-employee-skill.yaml)
+    * [e2e-qna-grounded-punctuation-skill](https://github.com/instructlab/instructlab/blob/main/scripts/test-data/compositional_skills/grounded/e2e-qna-grounded-punctuation.yaml)
+* Knowledge
+  * [e2e-qna-knowledge-mbta](https://github.com/instructlab/instructlab/blob/main/scripts/test-data/knowledge/e2e-qna-knowledge-mbta.yaml)
+  * [e2e-qna-knowledge-phoenix](https://github.com/instructlab/instructlab/blob/main/scripts/test-data/knowledge/e2e-qna-knowledge-phoenix.yaml)
+  * [e2e-qna-knowledge](https://github.com/instructlab/instructlab/blob/main/scripts/test-data/knowledge/e2e-qna-knowledge.yaml)
 
 ### Pregenerated Dataset (Input)