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

taxonomy mermaid diagram #1197

Closed
wants to merge 1 commit into from

Conversation

makelinux
Copy link
Contributor

@makelinux makelinux commented Jun 17, 2024

Preview
Preview:
image

@github-actions github-actions bot added the documentation Improvements or additions to documentation label Jun 17, 2024
TODO:
1. replace links to taxonomy_diagram.png from other repositories
2. delete taxonomy_diagram.png

Signed-off-by: Costa Shulyupin <[email protected]>
@makelinux
Copy link
Contributor Author

@jjasghar, who can review this, please?

@jjasghar
Copy link
Member

jjasghar commented Jul 1, 2024

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
Copy link
Member

jjasghar commented Jul 1, 2024

Also we #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
Copy link
Contributor

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
Copy link
Contributor Author

@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
Copy link
Contributor Author

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

@jjasghar
Copy link
Member

jjasghar commented Jul 1, 2024

@makelinux please take a look at #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
Copy link
Contributor

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?

Copy link

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.

@github-actions github-actions bot added the stale stale-bot has marked you as stale label Jul 17, 2024
@jjasghar jjasghar removed the stale stale-bot has marked you as stale label Jul 17, 2024
@kelbrown20
Copy link
Contributor

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

Copy link

github-actions bot commented Aug 2, 2024

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.

@github-actions github-actions bot added the stale stale-bot has marked you as stale label Aug 2, 2024
@jjasghar
Copy link
Member

@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 jjasghar removed the stale stale-bot has marked you as stale label Aug 21, 2024
@jjasghar
Copy link
Member

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
Loading

I'll update the PR with something cut down.

@jjasghar
Copy link
Member

Closing per: #1279, thank you @makelinux i have updated this PR :)

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.

4 participants