feat: allow custom callback in clip_client #849
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## main #849 +/- ##
==========================================
- Coverage 81.58% 79.32% -2.27%
==========================================
Files 21 21
Lines 1575 1596 +21
==========================================
- Hits 1285 1266 -19
- Misses 290 330 +40
Flags with carried forward coverage won't be shown. Click here to find out more.
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
ZiniuYu
changed the title
numb3r3
requested changes
Nov 1, 2022
|
please add description for this pr |
jemmyshin
requested changes
Nov 2, 2022
| ) | ||
| return results.embeddings if unbox else results | ||
| def _unboxed_result(results: Optional['DocumentArray'] = None, unbox: bool = False): | ||
| if results is not None: |
There was a problem hiding this comment.
why remove this raise ValueError?
tests/test_client.py
Outdated
| class ErrorExec(Executor): | ||
| @requests | ||
| def foo(self, docs, **kwargs): | ||
| 1 / 0 |
There was a problem hiding this comment.
raise an error here, do not do like this
tests/test_client.py
Outdated
| 'inputs', | ||
| [ | ||
| [], | ||
| DocumentArray([]), |
ZiniuYu
changed the title
|
📝 Docs are deployed on https://ft-callback--jina-docs.netlify.app 🎉 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
clip_clientby default collects all the results and returns them to users. In this pr, we enable the user to override this behavior by providing custom callbacks:on_done,on_error, andon_always. The usage of custom callbacks follows that of Jina client.We move all results collection logic to a default
on_donecallback, with or without async.We also move the code that updates the progress bar to a default
on_alwayscallback, which wraps the user-definedon_alwayscallback.We do not provide a default
on_errorcallback.This PR also fixes a small bug that unboxes empty input for the rank endpoint to unify the behavior of all endpoints.
clip_client