Skip to content

Updated the model card for CLIP #37040

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 13 commits into from
Apr 2, 2025
Merged

Updated the model card for CLIP #37040

merged 13 commits into from
Apr 2, 2025

Conversation

purusharthmalik
Copy link
Contributor

What does this PR do?

As suggested in this issue - #36979 (comment) - this PR updates the documentation of the CLIP model, which will now be aligned with the standardized format for all the docs.

Who can review?

@stevhliu, please let me know if any changes are needed.

@github-actions github-actions bot marked this pull request as draft March 27, 2025 10:28
@github-actions GitHub Actions
Copy link

Hi 👋, thank you for opening this pull request! The pull request is converted to draft by default. The CI will be paused while the PR is in draft mode. When it is ready for review, please click the Ready for review button (at the bottom of the PR page). This will assign reviewers and trigger CI.

@purusharthmalik purusharthmalik marked this pull request as ready for review March 27, 2025 10:35
@github-actions github-actions bot requested a review from stevhliu March 27, 2025 10:35
@stevhliu stevhliu mentioned this pull request Mar 27, 2025
Open
@HuggingFaceDocBuilderDev
Copy link

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.

@purusharthmalik
Copy link
Contributor Author

purusharthmalik commented Mar 28, 2025 •
edited
Loading

@stevhliu Are there any changes required?

stevhliu
stevhliu reviewed Mar 28, 2025
View reviewed changes
Copy link
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

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

Fantastic start! 🔥

purusharthmalik and others added 4 commits March 29, 2025 16:50
@purusharthmalik @stevhliu
Update docs/source/en/model_doc/clip.md
0c54a85 
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
@purusharthmalik @stevhliu
Update docs/source/en/model_doc/clip.md
dc56c9c 
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
@purusharthmalik @stevhliu
Update docs/source/en/model_doc/clip.md
1641265 
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
@purusharthmalik
Incorporated suggested changes
c4a2ab6
@purusharthmalik
Copy link
Contributor Author

All the suggested changes have been incorporated into the docs. Also, are model-specific loaders and processors being deprecated or are we just omitting them from the initial description about the model for standardization's sake?

stevhliu
stevhliu approved these changes Apr 2, 2025
View reviewed changes
Copy link
Member

@stevhliu stevhliu left a comment

Choose a reason for hiding this comment

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

Super nice! Just a few more changes and we can merge 🚀

purusharthmalik and others added 4 commits April 3, 2025 00:56
@purusharthmalik @stevhliu
Update docs/source/en/model_doc/clip.md
aff85d0 
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
@purusharthmalik @stevhliu
Update docs/source/en/model_doc/clip.md
e56b175 
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
@purusharthmalik @stevhliu
Update docs/source/en/model_doc/clip.md
86daaef 
Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
@purusharthmalik
Merge branch 'main' into main
d6be92f
@purusharthmalik
Copy link
Contributor Author

@stevhliu Done! Let's merge this, I'll get started on another model.

@stevhliu stevhliu merged commit 199d7ad into huggingface:main Apr 2, 2025
10 checks passed
duanjunwen pushed a commit to duanjunwen/transformers that referenced this pull request Apr 3, 2025
@purusharthmalik @stevhliu @duanjunwen
Updated the model card for CLIP (huggingface#37040)
dac6ab6 
* Update clip.md

* Update docs/source/en/model_doc/clip.md

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* Update docs/source/en/model_doc/clip.md

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* Update docs/source/en/model_doc/clip.md

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* Incorporated suggested changes

* Update docs/source/en/model_doc/clip.md

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* Update docs/source/en/model_doc/clip.md

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

* Update docs/source/en/model_doc/clip.md

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>

---------

Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@stevhliu stevhliu stevhliu approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@purusharthmalik @HuggingFaceDocBuilderDev @stevhliu