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

schema: Define JSON schema for taxonomy yaml #616

Merged
merged 1 commit into from
Mar 27, 2024
Merged

schema: Define JSON schema for taxonomy yaml #616

merged 1 commit into from
Mar 27, 2024

Conversation

bjhargrave
Copy link
Contributor

@bjhargrave bjhargrave commented Mar 22, 2024

We use JSON Schema which has broad support including in vscode. This PR includes the schema for compositional skills (without attribution) as well as prototype schema for knowledge and metadata. The check yaml script is changed to use the check-jsonschema command to validate the compositional skill qna.yaml files against the schema.

@bjhargrave bjhargrave requested review from a team as code owners March 22, 2024 00:03
@bjhargrave
Copy link
Contributor Author

bjhargrave commented Mar 22, 2024

This PR also removes the requirement for the attribution key in the qna.yaml files since the attribution information will be specified in another location.

@github-actions github-actions bot added the ci label Mar 25, 2024
Copy link
Contributor

@lehors lehors left a comment

Choose a reason for hiding this comment

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

LGTM
@xukai92 can you please review?

@lehors lehors requested a review from xukai92 March 25, 2024 13:51
.github/schemas/knowledge.json Show resolved Hide resolved
We use JSON Schema which has broad support including in vscode. This PR
includes the schema for compositional skills (without attribution) as
well as prototype schema for knowledge and metadata. The check yaml
script is changed to use the check-jsonschema command to validate
the compositional skill qna.yaml files against the schema.

Signed-off-by: BJ Hargrave <[email protected]>
@lehors lehors merged commit bd6325b into instructlab:main Mar 27, 2024
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants