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 Model Table Display into Readthedocs #624

Merged
merged 5 commits into from
Jun 24, 2024

Conversation

darrylong
Copy link
Member

Description

In this PR, we add a JS based table into readthedocs, so as to allow filtering/sorting functions for our growing number of models.

Related Issues

This supports #542, which could be used for further integration.

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 self-assigned this Jun 7, 2024
@darrylong darrylong marked this pull request as ready for review June 14, 2024 08:10
Copy link
Member

@lthoang lthoang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tqtg
Copy link
Member

tqtg commented Jun 17, 2024

@darrylong is it possible to include a few screenshots illustrating searching/filtering/sorting functions of the generated table?

@darrylong
Copy link
Member Author

@darrylong is it possible to include a few screenshots illustrating searching/filtering/sorting functions of the generated table?

Table on Readthedocs:
Screenshot 2024-06-18 at 11 01 46 AM

When filtering by keyword:
Screenshot 2024-06-18 at 11 03 09 AM

Content Based Models clicked:
Screenshot 2024-06-18 at 11 03 26 AM

Sorting when header is clicked:
Screenshot 2024-06-18 at 11 03 44 AM

@tqtg
Copy link
Member

tqtg commented Jun 18, 2024

The table looks great. Thanks @darrylong

There are some test errors related to Numpy version. We might need to fix them in another PR.

@darrylong darrylong merged commit 52979eb into PreferredAI:master Jun 24, 2024
13 of 22 checks passed
@darrylong darrylong deleted the interactive-model-display branch June 24, 2024 07:26
@darrylong darrylong added the docs Documentation (Readme, readthedocs) related label Jun 25, 2024
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.

None yet

3 participants