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: spelling correction #2190

Merged
merged 2 commits into from
Mar 17, 2021
Merged

docs: spelling correction #2190

merged 2 commits into from
Mar 17, 2021

Conversation

florian-hoenicke
Copy link
Member

No description provided.

@@ -36,7 +36,7 @@ def mixin_client_cli_parser(parser):
gp.add_argument(
'--top-k',
type=int,
help='The number of results will be returned. Sorted by their scores descendingly.',
help='The number of results will be returned. Sorted by their scores in descending order.',
Copy link
Member

Choose a reason for hiding this comment

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

We should remove this part, it is not guaranteed to be returned sorted in descending order

Copy link
Member Author

Choose a reason for hiding this comment

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

wow okay, I didn't know that. Interesting.
Is it because the rankers can change the sorting?

Copy link
Member

Choose a reason for hiding this comment

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

well, it is because it depends if u sort or not them, or if they come right after a Vector Search (where score is distance)

@codecov
Copy link

codecov bot commented Mar 16, 2021

Codecov Report

Merging #2190 (4076647) into master (3bf8c15) will increase coverage by 0.08%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2190      +/-   ##
==========================================
+ Coverage   90.41%   90.50%   +0.08%     
==========================================
  Files         208      208              
  Lines       11243    11243              
==========================================
+ Hits        10165    10175      +10     
+ Misses       1078     1068      -10     
Flag Coverage Δ
daemon 50.20% <ø> (ø)
jina 90.96% <ø> (+0.09%) ⬆️

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

Impacted Files Coverage Δ
jina/drivers/__init__.py 93.90% <ø> (ø)
jina/executors/__init__.py 92.27% <ø> (ø)
jina/executors/compound.py 89.31% <ø> (ø)
jina/executors/decorators.py 94.31% <ø> (ø)
jina/executors/indexers/__init__.py 97.82% <ø> (ø)
jina/executors/indexers/vector.py 95.68% <ø> (ø)
jina/executors/metas.py 96.87% <ø> (ø)
jina/flow/builder.py 96.96% <ø> (ø)
jina/parsers/client.py 100.00% <ø> (ø)
jina/schemas/meta.py 100.00% <ø> (ø)
... and 3 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3bf8c15...4076647. Read the comment docs.

@github-actions
Copy link

github-actions bot commented Mar 16, 2021

Latency summary

Current PR yields:

  • 😶 index QPS at 1003, delta to last 3 avg.: +0%
  • 😶 query QPS at 14, delta to last 3 avg.: -3%

Breakdown

Version Index QPS Query QPS
current 1003 14
1.0.10 1010 14
1.0.9 1006 14

Backed by latency-tracking. Further commits will update this comment.

@florian-hoenicke florian-hoenicke requested a review from JoanFM March 16, 2021 23:07
@@ -176,15 +176,15 @@ def write_handler(self):
return r

def get_query_handler(self):
"""Get a *readable* index handler when the ``index_abspath`` already exist, need to be overrided"""
"""Get a *readable* index handler when the ``index_abspath`` already exist, need to be overridden"""
Copy link
Member

Choose a reason for hiding this comment

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

just curious, should it be overwritten? checkout this link

Copy link
Contributor

Choose a reason for hiding this comment

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

You override a method, not overwrite it

Copy link
Contributor

Choose a reason for hiding this comment

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

@florian-hoenicke florian-hoenicke merged commit c278ba1 into master Mar 17, 2021
@florian-hoenicke florian-hoenicke deleted the docs-spelling-correction branch March 17, 2021 14:01
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.

5 participants