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.

Sign up for GitHub

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

Jump to bottom

docs(segmenter): improve segmenter docstring #1866

Merged
merged 1 commit into from
Feb 5, 2021
Merged

docs(segmenter): improve segmenter docstring #1866

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 1 addition & 5 deletions jina/executors/segmenters/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,7 @@ def __init__(self, *args, **kwargs):
self.logger.warning(f'{typename(self)} works on keys, but no keys are specified')

def segment(self, *args, **kwargs) -> List[Dict]:
"""The apply function of this executor.
Unlike :class:`BaseCrafter`, the :func:`craft` here works on doc-level info and the output is defined on
chunk-level. Therefore the name of the arguments should be always valid keys defined
in the doc-level protobuf whereas the output dict keys should always be valid keys defined in the chunk-level
protobuf.
"""
:return: a list of chunks-level info represented by a dict
"""
raise NotImplementedError