docs(drivers): add missing docstrings #1976
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
JoanFM
suggested changes
Feb 18, 2021
jina/drivers/evaluate.py
Outdated
| @@ -132,12 +128,19 @@ def __init__(self, | |||
|
|
|||
| @property | |||
| def single_field(self): | |||
| """Get single field.""" | |||
There was a problem hiding this comment.
Can u add here the comment. Property to guarantee compatibility when only one field is provided either as a string or as a unit length tuple
There was a problem hiding this comment.
Sure! Thanks!
Codecov Report
@@ Coverage Diff @@
## master #1976 +/- ##
==========================================
- Coverage 81.89% 81.52% -0.37%
==========================================
Files 148 148
Lines 7107 7081 -26
==========================================
- Hits 5820 5773 -47
- Misses 1287 1308 +21
Continue to review full report at Codecov.
|
Latency summaryCurrent PR yields:
Breakdown
Backed by latency-tracking. Further commits will update this comment. |
CatStark
reviewed
Feb 19, 2021
jina/drivers/evaluate.py
Outdated
| @@ -68,13 +68,11 @@ def _apply_all( | |||
| evaluation.ref_id = groundtruth.id | |||
|
|
|||
| def extract(self, doc: 'Document') -> Any: | |||
| """Extracting the to-be-evaluated field from the document. | |||
| Drivers inherit from :class:`BaseEvaluateDriver` must implement this method. | |||
| """Extract the to-be-evaluated field from the document. Drivers inherit from :class:`BaseEvaluateDriver` must implement this method. | |||
There was a problem hiding this comment.
I think the first line of the docstring must be one short sentence.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.