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

Readme: Brought "Knowledge" ahead of "Skills" #1311

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

Conversation

rfrht
Copy link

@rfrht rfrht commented Oct 4, 2024

For someone training their models, the most common use case is creating knowledge - and not skills. Knowledge QNAs have strict requirements, needs schema version 3 - and an interested party can be misled with the "skills" examples.

This commit brings Knowledge QNA ahead of Skills, highlight the difference between them - and also highlights the context and qna pair requirements.

signed-off-by: [email protected]

For someone training their models, the most **common use case** is creating knowledge - and not skills. Knowledge QNAs have strict requirements, needs schema version 3 - and an interested party can be misled with the "skills" examples.

This commit brings Knowledge QNA ahead of Skills, highlight the difference between them - and also highlights the context and qna pair requirements.

Signed-off-by: Rodrigo Freire <[email protected]>
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Oct 4, 2024
@jjasghar
Copy link
Member

jjasghar commented Oct 4, 2024

Thank you for this, but we are attempting to migrate to docs.instructlab.ai. This rewrite maybe worth looking at that repo instead

@rfrht
Copy link
Author

rfrht commented Oct 4, 2024

Thank you for this, but we are attempting to migrate to docs.instructlab.ai. This rewrite maybe worth looking at that repo instead

Hello, Asghar! Thanks for your review. I'll be definitely doing it - already forked it and will propose the changes over there too.

Meanwhile, can you approve this PR for this repo, hoping to help our users? I took issue on the thing because of the amount of time that I lost figuring out the qna :-)

Best regards,

  • RF.

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

Successfully merging this pull request may close these issues.

2 participants