-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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: create tutorial for qa bot #3886
Conversation
Codecov Report
@@ Coverage Diff @@
## master #3886 +/- ##
==========================================
+ Coverage 88.92% 89.88% +0.96%
==========================================
Files 168 168
Lines 12221 12221
==========================================
+ Hits 10867 10985 +118
+ Misses 1354 1236 -118
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.
Marked some place which can use markdown syntax instead of html tag, such as <em>
and </br>
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.
Looks good, just some minor comments
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.
make sure to upper-case Jina all throughout (unless it's the source-code package jina
)
Now let's move on to the last part and create the indexer. | ||
|
||
## Putting it Together with the Indexer | ||
The indexer is the only one of our `Executor`s that can handle more than one task. |
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.
Why did you re-implement SimpleIndexer? It's already a published Executor on hub. It is really relevant to the DocsQA to delve into it?
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.
Fair point. However, I would like to keep it in here since it has a few little additions to it, that are specific to the DocQA. Would you be fine with that?
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.
Which ones? Theoretically then, you should frame it as
- I forked the (already excellent :P ) SimpleIndexer to add this feature I needed for my scenario
- only show and discuss those LOCs
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.
Does the simple indexer sort the matches by similarity already?
If not, you're right. It would be super easy to use the indexer and simply grab the match with the largest similarity.
I'll change it.
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.
Just double-checked, it does sort https://github.com/jina-ai/executor-simpleindexer/pull/34/files
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.
Me and Joan synced in the morning and decided to move forward without changing the indexer to use the hub. The consensus was to not spend more time on this, since the main purpose of this tutorial is to log the idea of using doc2query for a qa bot and to show how to use jina for it. Hope you are okay with this?!
i think you need to squash the commits to fix the commit message a bit. |
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.
Some style changes
Co-authored-by: Zhaofeng Miao <522856232@qq.com>
Co-authored-by: Zhaofeng Miao <522856232@qq.com>
Co-authored-by: Zhaofeng Miao <522856232@qq.com>
Co-authored-by: Zhaofeng Miao <522856232@qq.com>
Co-authored-by: Zhaofeng Miao <522856232@qq.com>
Co-authored-by: Zhaofeng Miao <522856232@qq.com>
Co-authored-by: Zhaofeng Miao <522856232@qq.com>
Co-authored-by: Zhaofeng Miao <522856232@qq.com>
Adds a tutorial for a question answering bot that uses doc2query