search

instructlab / taxonomy

Taxonomy tree that will allow you to create models tuned with your data
Apache License 2.0
198 stars 801 forks source link

README.md skills examples different from demos and PRs #1133

Closed jimmysjolund closed 5 months ago

jimmysjolund commented 5 months ago

Describe the bug/problem When reading through the documentation it seems to me that the examples in the README.md on Skills show different yaml layout than what is used in different demo videos and actual PRs.

As example from https://github.com/instructlab/taxonomy/blob/main/README.md#getting-started-with-skill-contributions :

Freeform compositional skill: YAML example
version: 2
task_description: 'Teach the model how to rhyme.'
created_by: juliadenham
seed_examples:
  - question: What are 5 words that rhyme with horn?
    answer: warn, torn, born, thorn, and corn.

But in PRs and demo's I have watched the structure usually looks like:

created_by: jimmysjolund
seed_examples:
  - answer: warn, torn, born, thorn, and corn.
    question: What are 5 words that rhyme with horn?

Response that you expected instead I expected examples and actual contributions to look the same. I would be able to update the documentation, but want to check if this actually is an issue or me misunderstanding.

jjasghar commented 5 months ago

Yep, this has been moving very very fast. The luckily our linter has been keeping up with it the changes, and @kelbrown20 has kept the documentation up to date as best as they can. I'm going to close this because it's going to be an ongoing problem until we "stabilize," but thank you for raising it, and we will do our best to keep everything updated as possible.