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

Split model list on modality #18328

Merged
merged 4 commits into from
Aug 1, 2022
Merged

Conversation

stevhliu
Copy link
Member

This PR splits the model API list on modality because it was becoming difficult for users to discover what vision or audio models are supported because they just disappear in the long list. I set these sections to not expand by default since users are more likely interested in going straight to a modality and then expanding the list of supported models instead of scrolling past all the text models, for example.

@stevhliu stevhliu requested a review from NielsRogge July 27, 2022 22:34
@stevhliu stevhliu changed the title Split model list on modality [WIP] Split model list on modality Jul 27, 2022
@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Jul 27, 2022

The documentation is not available anymore as the PR was closed or merged.

Copy link
Contributor

@NielsRogge NielsRogge left a comment

Choose a reason for hiding this comment

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

Really awesome and really needed ❤️ thanks for working on that.

We could perhaps also split up the models in the main README, as well as the "big table of models", although I'm not sure about that. cc'ing @sgugger

@sgugger
Copy link
Collaborator

sgugger commented Jul 28, 2022

This requires more work than just splitting the navigation bar (as seen with the failing quality test). There are scripts that format this model ToC/check all models are documented which then need to be adapted.

Likewise splitting the big tables of models in the main README will require to rewrite a lot of the scripts that copy it to other READMEs and the index.

@sgugger
Copy link
Collaborator

sgugger commented Jul 28, 2022

I have made the necessary changes to the quality script that is failing but:

  • I don't have permission to push on this branch, so can't push them here
  • Your fork does not appear in the GitHub website for some reason, so I can't make a pull request either

You can find the changes in in this branch, just cherry-pick the commit.

Giving authorization to the maintainers to push on your branch when opening a pull request would make the whole process way smoother. Or just use the main fork (huggingface/transformers) instead of your personal fork :-)

Edit: Managed to open a PR by hacking some urls in GitHub (thank you for showing me @LysandreJik !). It's here. The changes in the toc are just rewrites from the Python yaml library.

@stevhliu stevhliu changed the title [WIP] Split model list on modality Split model list on modality Aug 1, 2022
@stevhliu stevhliu marked this pull request as ready for review August 1, 2022 16:09
@stevhliu stevhliu merged commit 151a2aa into huggingface:main Aug 1, 2022
@stevhliu stevhliu deleted the split-model-list branch August 1, 2022 16:10
oneraghavan pushed a commit to oneraghavan/transformers that referenced this pull request Sep 26, 2022
* 📝 split up model list

* Adapt script to reorg

* apply niels feedback

Co-authored-by: Sylvain Gugger <Sylvain.gugger@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants