Updating docs on TextSegmentation #654
Conversation
kolena/annotation.py
Outdated
| # Highlights 'Hello' in 'Hello, world' | ||
| TextSegment(text_field="text", start=0, end=6), | ||
| # Highlights 'summary of' in "A summary of current documentation." | ||
| TextSegment(text_field="summary", start=2, end=13), |
kolena/annotation.py
Outdated
| TextSegment(text_field="summary", start=10, end=51), | ||
| # Highlights 'Hello' in 'Hello, world' | ||
| TextSegment(text_field="text", start=0, end=6), | ||
| # Highlights 'summary of' in "A summary of current documentation." |
There was a problem hiding this comment.
should probably be consistent with single vs double quotes
kolena/annotation.py
Outdated
| text_segments: List[TextSegment] = [ | ||
| TextSegment(text_field="text", start=0, end=5), | ||
| TextSegment(text_field="summary", start=10, end=51), | ||
| # Highlights 'Hello' in 'Hello, world' |
There was a problem hiding this comment.
Are we sure that this is configured correctly? This doesn't seem to line up from the python side:
>>> text = 'Hello, world'
>>> summary = "A summary of current documentation."
>>> text[0:6]
'Hello,'
>>> summary[2:13]
'summary of '
There was a problem hiding this comment.
I am not sure actually :) I guess thats why this example is useful. I will change to above.
There was a problem hiding this comment.
to be clear, probably cleanest to adjust the indices to 0, 5 and 2, 12 (rather than the highlighted segment)
kolena/annotation.py
Outdated
| # Highlights "Hello" in "Hello, world" | ||
| TextSegment(text_field="text", start=0, end=5), | ||
| # Highlights "summary of" in "A summary of current documentation." | ||
| TextSegment(text_field="summary", start=2, end=12), |
There was a problem hiding this comment.
Should still be indented, right?
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## trunk #654 +/- ##
=======================================
Coverage 93.68% 93.68%
=======================================
Files 90 90
Lines 5624 5624
Branches 832 832
=======================================
Hits 5269 5269
Misses 270 270
Partials 85 85
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
Linked issue(s)
KOL-7079
What change does this PR introduce and why?
Please check if the PR fulfills these requirements