Skip to content

Commit

Permalink
docs(drivers): remove the legacy docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
nan-wang committed Feb 14, 2021
1 parent 97f9e97 commit 88e2dd2
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions jina/drivers/rank/aggregate/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,24 +14,24 @@


class BaseAggregateMatchesRanker(BaseRankDriver):
"""Drivers inherited from this Driver will focus on aggregating scores from `chunks` to its `parents`."""
"""Drivers inherited from this Driver focus on aggregating scores from `chunks` to its `parents`."""

def __init__(self,
keep_source_matches_as_chunks: bool = False,
*args,
**kwargs):
"""
`keep_old_matches_as_chunks` is useful to keep track of the chunks that lead to a retrieved result.
.. note::
- The chunks of the matches will only contain the chunks that lead to the document matching, not all the chunks of the match.
:param keep_source_matches_as_chunks: A flag to indicate if the driver must return the old matches of the query or its chunks
(at a greater granularity level (k + 1)) as the chunks of the new computed `matches` (at granularity level k)
Set it to `True` when keeping track of the chunks that lead to a retrieved result.
:param *args: *args for super
:param **kwargs: **kwargs for super
.. note::
When set `keep_source_matches_as_chunks=True`, the chunks of the match contains **ONLY** the chunks leading
to the match rather than **ALL** the chunks of the match.
"""
super().__init__(*args, **kwargs)
self.keep_source_matches_as_chunks = keep_source_matches_as_chunks
Expand Down

0 comments on commit 88e2dd2

Please sign in to comment.