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 note on compound executor #3406
Conversation
Latency summaryCurrent PR yields:
Breakdown
Backed by latency-tracking. Further commits will update this comment. |
Codecov Report
@@ Coverage Diff @@
## master #3406 +/- ##
==========================================
+ Coverage 89.85% 90.26% +0.41%
==========================================
Files 152 152
Lines 10841 10908 +67
==========================================
+ Hits 9741 9846 +105
+ Misses 1100 1062 -38
Flags with carried forward coverage won't be shown. Click here to find out more.
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
9262394
to
a40f953
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I feel like the guide in docs/advanced/experimental/compound_executors.md is not complete? it introduces what is CompoundExecutor, but it does not give any MWU to showcase it, or reference.
a40f953
to
43c2385
Compare
Expanded with a basic example. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Typo
43c2385
to
12a6014
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
minor revision
- combining a Storage and a Search Indexer in one, for easier access, scaling etc. | ||
- combining a custom ranker and an Indexer in one, for cases where `top_k` is not achieved after a ranking process filters out results | ||
- having Indexers that store multiple level of granularity in one Executor, for easier lookup and custom logic | ||
|
||
If you want to develop a `CompoundExecutor`-type Executor based on one of the Executors existing in Jina Hub, you have to copy-paste the code of the classes you need into your own Executor's package. | ||
This is because, for now, the Executors in Jina Hub can **not** be imported as Python modules. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- combining a Storage and a Search Indexer in one, for easier access, scaling etc. | |
- combining a custom ranker and an Indexer in one, for cases where `top_k` is not achieved after a ranking process filters out results | |
- having Indexers that store multiple level of granularity in one Executor, for easier lookup and custom logic | |
If you want to develop a `CompoundExecutor`-type Executor based on one of the Executors existing in Jina Hub, you have to copy-paste the code of the classes you need into your own Executor's package. | |
This is because, for now, the Executors in Jina Hub can **not** be imported as Python modules. | |
- combining a Storage and a Search Indexer in one, for easier access, scaling etc. | |
- combining a custom ranker and an Indexer in one, for cases where `top_k` is not achieved after a ranking process filters out results | |
- having Indexers that store multiple levels of granularity in one Executor, for easier lookup and custom logic | |
````{caution} | |
If you want to develop a `CompoundExecutor`-type Executor based on one of the Executors existing in Jina Hub, you have to copy-paste the code of the classes you need into your own Executor's package. | |
This is because, for now, the Executors in Jina Hub can **not** be imported as Python modules. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
seems my "` * 4" does not work on Github IDE, the closing quote is eaten by it
Co-authored-by: Han Xiao <artex.xh@gmail.com>
Co-authored-by: Han Xiao <artex.xh@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
few glitches, let me directly working on this branch
No description provided.