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 clip resources to the transformers documentation #20190

Merged
merged 4 commits into from
Nov 15, 2022

Conversation

ambujpawar
Copy link
Contributor

@ambujpawar ambujpawar commented Nov 13, 2022

What does this PR do?

Fixes #20055 (partially)

Before submitting

Who can review?

@stevhliu Please can you have a look?

@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint.

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.

Thanks for adding these! I just added a comment on removing non-CLIP specific resources and also Spaces.

docs/source/en/model_doc/clip.mdx Outdated Show resolved Hide resolved
docs/source/en/model_doc/clip.mdx Outdated Show resolved Hide resolved
docs/source/en/model_doc/clip.mdx Outdated Show resolved Hide resolved
docs/source/en/model_doc/clip.mdx Outdated Show resolved Hide resolved
docs/source/en/model_doc/clip.mdx Outdated Show resolved Hide resolved
@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint.

@ambujpawar ambujpawar requested a review from stevhliu November 14, 2022 20:07
@stevhliu stevhliu mentioned this pull request Nov 15, 2022
20 tasks
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.

Awesome, thank you so much! Pinging @sgugger for a final look :)

Copy link
Collaborator

@sgugger sgugger left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution!

@sgugger sgugger merged commit c19aa7a into huggingface:main Nov 15, 2022
Comment on lines +89 to +94
<PipelineTag pipeline="image-to-text"/>
- A notebook showing [Video to text matching with CLIP for videos](https://colab.research.google.com/github/NielsRogge/Transformers-Tutorials/blob/master/X-CLIP/Video_text_matching_with_X_CLIP.ipynb).


<PipelineTag pipeline="zero-shot-classification"/>
- A notebook showing [Zero shot video classification using CLIP for video](https://colab.research.google.com/github/NielsRogge/Transformers-Tutorials/blob/master/X-CLIP/Zero_shot_classify_a_YouTube_video_with_X_CLIP.ipynb).
Copy link
Contributor

Choose a reason for hiding this comment

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

These are resources for X-CLIP, not CLIP.

Comment on lines +85 to +86
- A blog post on [How to use CLIP to retrieve images from text](https://huggingface.co/blog/fine-tune-clip-rsicd).
- A blog bost on [How to use CLIP for Japanese text to image generation](https://huggingface.co/blog/japanese-stable-diffusion).
Copy link
Contributor

@NielsRogge NielsRogge Nov 15, 2022

Choose a reason for hiding this comment

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

The first sentence should be something along the lines of "How to fine-tune CLIP on image-text pairs" rather than "How to retrieve...", the second one is not relevant for CLIP, as it's a blog about Stable Diffusion.

@NielsRogge
Copy link
Contributor

Folks, please make sure resources which are added are talking about the particular model.

mpierrau pushed a commit to mpierrau/transformers that referenced this pull request Dec 15, 2022
* WIP: Added CLIP resources from HuggingFace blog

* ADD: Notebooks documentation to clip

* Add link straight to notebook

Co-authored-by: Steven Liu <[email protected]>

* Change notebook links to colab

Co-authored-by: Ambuj Pawar <[email protected]>
Co-authored-by: Steven Liu <[email protected]>
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.

Model resources contribution
5 participants