Clarify num of docs in corpora when action and metadata is used #1167
Conversation
This file contains 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
dliappis
added
enhancement
In the typical cases of corpora that doesn't include an action-and-meta -data line, defining the number of documents is simple and equivalent to the number of lines. This commit clarifies that this calculation differs when using the `includes-action-and-meta-data` property and that number of documents should not include action-and-meta-data lines.
danielmitterdorfer
approved these changes
Feb 3, 2021
docs/track.rst
Outdated
|
|
||
| .. note:: | ||
|
|
||
| In this case the ``documents`` property should only reflect the number of documents and not additionally include the number of action and metadata lines. |
There was a problem hiding this comment.
"In this case" refers to the case when includes-action-and-meta-data is set to true. Maybe we should say instead:
When ``includes-action-and-meta-data`` is set to ``true``...
There was a problem hiding this comment.
Thanks. It's actually an interesting situation when a corpus contains action and metadata line but this property isn't true: it'll try to index them, frequently failing due to strict mappings :)
I've reworded with slightly fewer words to avoid cognitive load from repetition of terms in 20c839e
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.
In the typical cases of corpora that doesn't include an action-and-meta
-data line, defining the number of documents is simple and equivalent
to the number of lines.
This commit clarifies that this calculation differs when using the
includes-action-and-meta-dataproperty and that number of documentsshould not include action-and-meta-data lines.