instructlab / taxonomy

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

taxonomy mermaid diagram #1197

Closed makelinux closed 1 month ago

makelinux commented 3 months ago

Preview Preview: image

makelinux commented 3 months ago

@jjasghar, who can review this, please?

jjasghar commented 3 months ago

We've had a few conversations about this in the triage meeting, I don't think we've ever landed on how we want this displayed. @kelbrown20 can you put your vote here please?

jjasghar commented 3 months ago

Also we https://github.com/instructlab/taxonomy/pull/1215 which will be reorganizing a fair amount of the tree, so we would need to update it as soon as it is merged.

kelbrown20 commented 3 months ago

I was kinda confused about this bc we already have a taxonomy diagram here https://github.com/instructlab/taxonomy/blob/main/docs/taxonomy_diagram.png

makelinux commented 3 months ago

@kelbrown20, the old diagram is in raster png format and is difficult to maintain (not practical at all). The new diagram is in conceptual meta format mermaid, which is rendered automatically. It is very easy to maintain.

makelinux commented 3 months ago

@jjasghar, I would like to join to classification discussion. I like to cassificate.

jjasghar commented 3 months ago

@makelinux please take a look at https://github.com/instructlab/taxonomy/pull/1215 and put any comments on there you'd like. @mcorbin-ibm has put a ton of work into it and would love more feedback.

mcorbin-ibm commented 3 months ago

The new diagram is in conceptual meta format mermaid, which is rendered automatically. It is very easy to maintain.

@makelinux This is very cool if it can automatically render a taxonomy diagram based on the folders in the repo? Can it then be pulled into our docs/readme file for the repo?

github-actions[bot] commented 2 months ago

This pull request has been automatically marked as stale because it has not had activity within 15 days. It will be automatically closed if no further activity occurs within 31 days.

kelbrown20 commented 2 months ago

These updates look good to me, @juliadenham I know you wanted to take a look at this as well

github-actions[bot] commented 1 month ago

This pull request has been automatically marked as stale because it has not had activity within 15 days. It will be automatically closed if no further activity occurs within 31 days.

jjasghar commented 1 month ago

@mcorbin-ibm this is the mermaid diagram. Can we spend a few mins talking about it and I believe we should update it and merge it in for the changes we have.

jjasghar commented 1 month ago

a "full version" is here becaues of #1215

 flowchart TD;
   na[not accepting contributions\n at this time]:::na
   taxonomy --> foundational_skill & compositional_skills & knowledge

   foundational_skill:::na --> reasoning:::na
   reasoning:::na --> common_sense_reasoning:::na
   reasoning:::na --> linguistics_reasoning:::na
   reasoning:::na --> locgical_reasoning:::na
   reasoning:::na --> mathematical_reasoning:::na
   reasoning:::na --> temporal_reasoning:::na
   reasoning:::na --> theory_of_mind:::na
   reasoning:::na --> unconventional_reasoning:::na

   compositional_skills --> arts
   compositional_skills --> engineering
   compositional_skills --> geography
   compositional_skills --> grounded
   compositional_skills --> history
   compositional_skills --> lingustics
   compositional_skills --> miscellaneous_unknown
   compositional_skills --> philosophy
   compositional_skills --> religion
   compositional_skills --> science
   compositional_skills --> technology

   grounded --> grounded/arts
   grounded --> grounded/engineering
   grounded --> grounded/geography
   grounded --> grounded/history
   grounded --> grounded/lingustics
   grounded --> grounded/miscellaneous_unknown
   grounded --> grounded/philosophy
   grounded --> grounded/religion
   grounded --> grounded/science
   grounded --> grounded/technology

   knowledge --> knowledge/arts
   knowledge --> knowledge/engineering
   knowledge --> knowledge/geography
   knowledge --> knowledge/history
   knowledge --> knowledge/lingustics
   knowledge --> knowledge/miscellaneous_unknown
   knowledge --> knowledge/philosophy
   knowledge --> knowledge/religion
   knowledge --> knowledge/science
   knowledge --> knowledge/technology
   knowledge/science --> animals --> birds --> black_capped_chickadee --> black_capped_chikadee-a & black_capped_chikadee-q
   knowledge/science --> astronomy --> constellations --> phoenix --> phoenix-a & phoenix-q

   black_capped_chikadee-a{attribution.txt}
   black_capped_chikadee-q{qna.yaml}
   phoenix-a{attribution.txt}
   phoenix-q{qna.yaml}
   classDef na fill:#EEE

I'll update the PR with something cut down.

jjasghar commented 1 month ago

Closing per: https://github.com/instructlab/taxonomy/pull/1279, thank you @makelinux i have updated this PR :)