-
Notifications
You must be signed in to change notification settings - Fork 26.7k
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 docs on zeroshot image classification prompt templates #31343
Add docs on zeroshot image classification prompt templates #31343
Conversation
i have a PR that adds support for siglip training coming up so would be great if this could be merged asap so the docs don't merge conflict |
@aliencaocao I appreciate that you want to have PRs merged in as soon as possible (we do too!) but managing conflicts for other PRs isn't something that we will consider, unless it's also for transformers something we want to merge in and linked to. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for contributing to improving the docs!
I'm important to distinguish between what the user must feed to the model, and a useful example. The "This is a photo of {}" prompt just helps replicate the values from the pipeline, but it's not a requirement and can in fact be changed in the pipeline too.
Update usage tips
@amyeroberts heads up i've made the changes already |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
Just two tiny nits
Co-authored-by: amyeroberts <[email protected]>
Co-authored-by: amyeroberts <[email protected]>
Merged your suggestions |
@aliencaocao Can you try rebasing to include the latest changes upstream? This should resolve some of the issues on the CI runs |
@amyeroberts hi somehow the workflows arent getting triggered? |
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
@aliencaocao We've had a few issues with tests triggering on circle CI today. I'm not 100% sure of the cause, but other PRs which have blocked workflows are now working. Could you try triggering a new run? |
@amyeroberts its ready now |
Thanks for updating the docs and your patience with the CI! |
* Add docs on pipeline templates * Fix example and comments Update usage tips * Update docs/source/en/tasks/zero_shot_image_classification.md Co-authored-by: amyeroberts <[email protected]> * Update docs/source/en/model_doc/siglip.md Co-authored-by: amyeroberts <[email protected]> * Trigger CI --------- Co-authored-by: amyeroberts <[email protected]>
What does this PR do?
Adds documentation on prompt templates for Zero Shot Image Classification tasks so that the output results match pipelines and are also correct. Not applying the template can lead to greatly worsened accuracy.
Fixes #30951
Before submitting
Pull Request section?
to it if that's the case.
documentation guidelines, and
here are tips on formatting docstrings.
Who can review?
@amyeroberts