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.

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

docs: update clip search #820

Merged
merged 16 commits into from
Sep 13, 2022
Merged

docs: update clip search #820

merged 16 commits into from
Sep 13, 2022

Conversation

numb3r3
Copy link
Member

@numb3r3 numb3r3 commented Sep 13, 2022

No description provided.

@codecov
Copy link

codecov bot commented Sep 13, 2022 •
edited

Codecov Report

Merging #820 (819ea4d) into main (213ecc2) will decrease coverage by 2.13%.
The diff coverage is 100.00%.

❗ Current head 819ea4d differs from pull request most recent head 1008dea. Consider uploading reports for the commit 1008dea to get more accurate results

@@            Coverage Diff             @@
##             main     #820      +/-   ##
==========================================
- Coverage   84.30%   82.17%   -2.14%     
==========================================
  Files          21       21              
  Lines        1548     1548              
==========================================
- Hits         1305     1272      -33     
- Misses        243      276      +33
Flag Coverage Δ
cas 82.17% <100.00%> (-2.14%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
client/clip_client/client.py 87.45% <100.00%> (ø)
server/clip_server/model/trt_utils.py 56.04% <0.00%> (-27.48%) ⬇️
server/clip_server/model/clip_trt.py 69.38% <0.00%> (-16.33%) ⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@github-actions github-actions bot added size/s and removed size/xs labels Sep 13, 2022
jemmyshin
jemmyshin requested changes Sep 13, 2022
View reviewed changes
Copy link
Member

@jemmyshin jemmyshin left a comment

Choose a reason for hiding this comment

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

change the server

docs/playground/searching.md Outdated Show resolved Hide resolved
ZiniuYu
ZiniuYu reviewed Sep 13, 2022
View reviewed changes
docs/user-guides/retriever.md
@@ -1,4 +1,4 @@
# Search API
# CLIP Search


CLIP Search is a search paradigm that uses the CLIP model to encode the text and image documents into a common vector space.
Copy link
Member

Choose a reason for hiding this comment

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

In the image, should be 'matched results'

docs/user-guides/retriever.md Show resolved Hide resolved
docs/user-guides/client.md
## Searching

You can use {func}`~clip_client.client.Client.search` or {func}`~clip_client.client.Client.asearch`
to search for relevant Documents in the index for a given query.
Copy link
Member

Choose a reason for hiding this comment

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

For more information...

docs/user-guides/client.md
```


The results will look like this, the most relevant doc is "she smiled, with pain" with the cosine distance of 0.096. And the apple image has the cosine distance of 0.799.
Copy link
Member

Choose a reason for hiding this comment

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

I think we can explain a little bit about how to interpret the result. For example: 'since by default we use cosine score, the smaller the value means...'

docs/user-guides/client.md Show resolved Hide resolved
@ZiniuYu
Copy link
Member

ZiniuYu commented Sep 13, 2022

I don't see anything about limit in the docs 🥹

@github-actions
Copy link

📝 Docs are deployed on https://ft-fix-search-docs--jina-docs.netlify.app 🎉

@numb3r3 numb3r3 merged commit 8d9725f into main Sep 13, 2022
@numb3r3 numb3r3 deleted the fix-search-docs branch September 13, 2022 13:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ZiniuYu ZiniuYu ZiniuYu left review comments

@jemmyshin jemmyshin jemmyshin requested changes

Assignees
No one assigned
Labels
area/docs component/client size/m
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@numb3r3 @ZiniuYu @jemmyshin