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: update finetuner docs #843

Merged
merged 9 commits into from
Oct 21, 2022
Merged

docs: update finetuner docs #843

merged 9 commits into from
Oct 21, 2022

Conversation

jemmyshin
Copy link
Member

since finetuner updates their model repo, we need to update our docs. Also we need to specify to_onnx=True in finetuner.fit()

@codecov
Copy link

codecov bot commented Oct 12, 2022

Codecov Report

Merging #843 (ea2ec7d) into main (87fdc54) will decrease coverage by 2.09%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##             main     #843      +/-   ##
==========================================
- Coverage   81.58%   79.49%   -2.10%     
==========================================
  Files          21       21              
  Lines        1575     1575              
==========================================
- Hits         1285     1252      -33     
- Misses        290      323      +33     
Flag Coverage Δ
cas 79.49% <ø> (-2.10%) ⬇️

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

Impacted Files Coverage Δ
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.

docs/user-guides/finetuner.md Outdated Show resolved Hide resolved
@@ -92,6 +94,7 @@ run = finetuner.fit(
learning_rate=1e-5,
loss='CLIPLoss',
cpu=False,
to_onnx=True,
Copy link
Member

Choose a reason for hiding this comment

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

As finetuner supports open_clip, can we finetune model='ViT-B-32::openai' in this tutorial.

Copy link
Member

Choose a reason for hiding this comment

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

this model name does not match that in finetuner

Comment on lines 182 to 187
Note that `finetuner`==0.6.2 doesn't support these new clip models trained on Laion2B:
- ViT-B-32::laion2b-s34b-b79k
- ViT-L-14::laion2b-s32b-b82k
- ViT-H-14::laion2b-s32b-b79k
- ViT-g-14::laion2b-s12b-b42k
```
Copy link
Member

Choose a reason for hiding this comment

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

Can we provide the full model list supported in finetuner. This is not a release notes where the updated information is fine. As the official documentation, we should provide complete information.

Copy link
Member Author

Choose a reason for hiding this comment

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

Model names in finetuner are not the same as in cas, which is confusing. Should we creat a mapping for the model names?

docs/user-guides/finetuner.md Outdated Show resolved Hide resolved
Copy link
Member

@bwanglzu bwanglzu left a comment

Choose a reason for hiding this comment

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

Thanks! Left some minor comments

docs/user-guides/finetuner.md Outdated Show resolved Hide resolved
docs/user-guides/finetuner.md Outdated Show resolved Hide resolved
docs/user-guides/finetuner.md Outdated Show resolved Hide resolved
docs/user-guides/finetuner.md Outdated Show resolved Hide resolved
docs/user-guides/finetuner.md Show resolved Hide resolved
docs/user-guides/finetuner.md Show resolved Hide resolved
docs/user-guides/finetuner.md Outdated Show resolved Hide resolved
docs/user-guides/finetuner.md Outdated Show resolved Hide resolved
docs/user-guides/finetuner.md Outdated Show resolved Hide resolved
@github-actions
Copy link

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

Copy link
Member

@numb3r3 numb3r3 left a comment

Choose a reason for hiding this comment

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

LGTM

@numb3r3 numb3r3 merged commit baf94b5 into main Oct 21, 2022
@numb3r3 numb3r3 deleted the docs-finetuner-update branch October 21, 2022 02:38
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.

None yet

4 participants