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

docs: add link and intro to inference api #900

Merged
merged 17 commits into from
Mar 26, 2023
Merged

docs: add link and intro to inference api #900

merged 17 commits into from
Mar 26, 2023

Conversation

ZiniuYu
Copy link
Member

@ZiniuYu ZiniuYu commented Mar 22, 2023

NOTE: DO NOT MERGE
After review, I will change the banner image url to a stable one

Please check https://github.com/jina-ai/clip-as-service/tree/docs-link-to-jac for readme

@codecov
Copy link

codecov bot commented Mar 22, 2023

Codecov Report

Merging #900 (7a286c4) into main (cce3b05) will decrease coverage by 11.13%.
The diff coverage is n/a.

❗ Current head 7a286c4 differs from pull request most recent head 08c4766. Consider uploading reports for the commit 08c4766 to get more accurate results

@@             Coverage Diff             @@
##             main     #900       +/-   ##
===========================================
- Coverage   82.73%   71.61%   -11.13%     
===========================================
  Files          23       23               
  Lines        1564     1564               
===========================================
- Hits         1294     1120      -174     
- Misses        270      444      +174     
Flag Coverage Δ
cas 71.61% <ø> (-11.13%) ⬇️

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

see 4 files with indirect coverage changes

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

@ZiniuYu ZiniuYu closed this Mar 23, 2023
@ZiniuYu ZiniuYu reopened this Mar 23, 2023
README.md Outdated
<br>
<b>Embed images and sentences into fixed-length vectors with CLIP</b>
<a href="https://cloud.jina.ai/user/inference">
<img src="https://github.com/jina-ai/clip-as-service/blob/4b315ae60087e1318bdceea19c55cdfd389687af/.github/README-img/banner.svg?raw=true" width="100%">
Copy link
Member

Choose a reason for hiding this comment

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

keep it in mind to change the src URL.

@ZiniuYu ZiniuYu requested a review from saahil March 23, 2023 07:06
@ZiniuYu ZiniuYu marked this pull request as ready for review March 23, 2023 10:21
Copy link

@saahil saahil left a comment

Choose a reason for hiding this comment

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

Left some comments in docs and banner.

docs/hosting/by-jina.md Outdated Show resolved Hide resolved
However, the "best model" is not always the best choice for your application. You may want to use a smaller model for faster response time, or a larger model for better accuracy. We provide the Inference API for you to customize your models, and this feature is currently in beta.
However, the "best model" is not always the best choice for your application. You may want to use a smaller model for faster response time, or a larger model for better accuracy.
With the [Inference API](https://cloud.jina.ai/user/inference) in [Jina AI Cloud](https://cloud.jina.ai/), you have the flexibility to choose the model that best suits your specific needs.
You can easily switch between models and customize the settings to achieve the desired balance between accuracy and speed.
Copy link

Choose a reason for hiding this comment

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

I believe, we can remove lines 16, 17 and 18 - it's a lot of text without much information gain and, IMO its suited better to our landing page.

.github/README-img/banner.svg Outdated Show resolved Hide resolved
@ZiniuYu ZiniuYu merged commit f4eed3b into main Mar 26, 2023
@ZiniuYu ZiniuYu deleted the docs-link-to-jac branch March 26, 2023 20:30
@github-actions
Copy link

📝 Docs are deployed on https://ft-docs-link-to-jac--jina-docs.netlify.app 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants