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

Add multimodality table to documentation #639

Merged
merged 10 commits into from
Jul 30, 2024

Conversation

darrylong
Copy link
Member

@darrylong darrylong commented Jul 19, 2024

Description

This PR adds an additional table below the existing model table in readthedocs, showing the modality each model supports.
Also, layout of page is widened to support more content in tables.

An preview of the table is as follows:
image

Related Issues

Fixes #634

Checklist:

  • I have added tests.
  • I have updated the documentation accordingly.
  • I have updated README.md (if you are adding a new model).
  • I have updated examples/README.md (if you are adding a new example).
  • I have updated datasets/README.md (if you are adding a new dataset).

@darrylong darrylong requested review from lthoang and tqtg July 19, 2024 08:06
@darrylong darrylong self-assigned this Jul 19, 2024
@tqtg
Copy link
Member

tqtg commented Jul 19, 2024

Couple of things:

  1. Too many red crosses (unappealing), we might just leave them as blank.
  2. Let's not have the Feature column. For any model that support FeatureModality, we can tick all the corresponding user/item Text, Image, and Graph because these modalities can be transformed to features. This will simplify the table too.

Let me know what you think.

@darrylong
Copy link
Member Author

Couple of things:

  1. Too many red crosses (unappealing), we might just leave them as blank.
  2. Let's not have the Feature column. For any model that support FeatureModality, we can tick all the corresponding user/item Text, Image, and Graph because these modalities can be transformed to features. This will simplify the table too.

Let me know what you think.

@lthoang let me know what you think as well. thanks

@darrylong
Copy link
Member Author

This is how it looks like after removing user/item feature columns and removing the crosses.

image

@lthoang
Copy link
Member

lthoang commented Jul 22, 2024

This is how it looks like after removing user/item feature columns and removing the crosses.

image

I agree that this one looks better.

@darrylong darrylong added the docs Documentation (Readme, readthedocs) related label Jul 22, 2024
@tqtg
Copy link
Member

tqtg commented Jul 22, 2024

Yeah, it looks great. One minor thing, it might be better to add column dividers/separators for the table.

@darrylong
Copy link
Member Author

This is the update after adding dividers and removing crosses.
image

@tqtg
Copy link
Member

tqtg commented Jul 24, 2024

LGTM!

@darrylong darrylong merged commit 706ce7a into PreferredAI:master Jul 30, 2024
24 checks passed
@darrylong darrylong deleted the add-model-tables branch July 30, 2024 02:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation (Readme, readthedocs) related
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[FEATURE] Categorizing models by supported modalities
3 participants