Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update URLs in docs/dataset_formats.md to point to the new InstructLab scripts/test-data files #448

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update URLs in docs/dataset_formats.md to point to the new InstructLab scripts/test-data files #448

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .spellcheck-en-custom.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ Backport
backported
CLI
codebase
composable
Composable
composable
config
configs
customizable
Expand All @@ -29,6 +29,7 @@ JSON
Langchain's
LLM
LLMBlock
mbta
MCQ
Merlinite
Mixtral
Expand Down
14 changes: 11 additions & 3 deletions docs/dataset_formats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changes look good, my only question is whether we want to list all of the them. Should we just refer to the directories now?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was wondering that too, especially if we start adding even more YAMLs over time. (Could make for a lengthy list.)

Also, the new sub-directory names are pretty self explanatory IMO.

I'm open to either approach

* 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)

Expand Down
Loading