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.

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

Conversation

courtneypacheco
Copy link
Contributor

The scripts/test-data directory structure was modified in the instructlab/instructlab repo to accommodate more skill + knowledge files, which means we need to update the scripts/test-data URLs in docs/dataset_formats.md accordingly.

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]>
@courtneypacheco courtneypacheco force-pushed the update-dataset-format-doc branch from 6f82fe5 to 6397b6e Compare December 11, 2024 16:44
@mergify mergify bot added CI/CD Affects CI/CD configuration documentation Improvements or additions to documentation labels Dec 11, 2024
* [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

@nathan-weinberg nathan-weinberg requested a review from a team December 18, 2024 18:22
Copy link
Contributor

@bbrowning bbrowning left a comment

Choose a reason for hiding this comment

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

Just a small issue with one broken link we should fix, but thanks for updating this!

Longer-term I'd like to probably just link to the core or taxonomy repos for any/all discussion of the taxonomy format, but that is probably best done once we move preprocessing out of SDG.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI/CD Affects CI/CD configuration documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants