[DOCS] Fix the weighed average documentation #81307
Merged
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
The documentations states that if the `weight` field is missing, and no explicit missing configuration is provided, a default value of 1 is used. This is incorrect and does not match the implementation of the weighted average aggregator. In this specific case the document is skipped, instead.
|
Pinging @elastic/es-docs (Team:Docs) |
salvatore-campagna
added
auto-backport-and-merge
v7.15.3
v7.16.1
v8.0.0
:Analytics/Aggregations
elasticmachine
added
the
Team:Analytics
|
Pinging @elastic/es-analytics-geo (Team:Analytics) |
jrodewig
reviewed
Dec 3, 2021
There was a problem hiding this comment.
Thanks @salvatore-campagna. I left a suggestion that fixes up some incorrect text surrounding your change. Let me know what you think.
Comment on lines
210
to
215
| The `missing` parameter defines how documents that are missing a value should be treated. | ||
| The default behavior is different for `value` and `weight`: | ||
|
|
||
| By default, if the `value` field is missing the document is ignored and the aggregation moves on to the next document. | ||
| If the `weight` field is missing, it is assumed to have a weight of `1` (like a normal average). | ||
| By default, if the `value` or `weight` field is missing the document is ignored and the aggregation moves on to the next document. | ||
|
|
||
| Both of these defaults can be overridden with the `missing` parameter: |
There was a problem hiding this comment.
Some of the text surrounding this change is still incorrect. For example:
The default behavior is different for
valueandweight:
is still wrong.
I left a suggestion that fixes up the surrounding text and shortens this a bit. I also updated the text to mention null values, which are treated the same as missing values based on my testing. Feel free to change the wording or let me know what you think.
Suggested change
| The `missing` parameter defines how documents that are missing a value should be treated. | |
| The default behavior is different for `value` and `weight`: | |
| By default, if the `value` field is missing the document is ignored and the aggregation moves on to the next document. | |
| If the `weight` field is missing, it is assumed to have a weight of `1` (like a normal average). | |
| By default, if the `value` or `weight` field is missing the document is ignored and the aggregation moves on to the next document. | |
| Both of these defaults can be overridden with the `missing` parameter: | |
| By default, the aggregation excludes documents with a missing or `null` value | |
| for the `value` or `weight` field. Use the `missing` parameter to specify a | |
| default value for these documents instead. |
salvatore-campagna
added a commit
to salvatore-campagna/elasticsearch
that referenced
this pull request
Dec 7, 2021
The documentations states that if the `weight` field is missing, and no explicit missing configuration is provided, a default value of 1 is used. This is incorrect and does not match the implementation of the weighted average aggregator. In this specific case the document is skipped, instead.
salvatore-campagna
added a commit
to salvatore-campagna/elasticsearch
that referenced
this pull request
Dec 7, 2021
The documentations states that if the `weight` field is missing, and no explicit missing configuration is provided, a default value of 1 is used. This is incorrect and does not match the implementation of the weighted average aggregator. In this specific case the document is skipped, instead.
salvatore-campagna
added a commit
to salvatore-campagna/elasticsearch
that referenced
this pull request
Dec 7, 2021
The documentations states that if the `weight` field is missing, and no explicit missing configuration is provided, a default value of 1 is used. This is incorrect and does not match the implementation of the weighted average aggregator. In this specific case the document is skipped, instead.
💚 Backport successful
|
elasticsearchmachine
pushed a commit
that referenced
this pull request
Dec 7, 2021
The documentations states that if the `weight` field is missing, and no explicit missing configuration is provided, a default value of 1 is used. This is incorrect and does not match the implementation of the weighted average aggregator. In this specific case the document is skipped, instead.
elasticsearchmachine
pushed a commit
that referenced
this pull request
Dec 7, 2021
The documentations states that if the `weight` field is missing, and no explicit missing configuration is provided, a default value of 1 is used. This is incorrect and does not match the implementation of the weighted average aggregator. In this specific case the document is skipped, instead.
elasticsearchmachine
pushed a commit
that referenced
this pull request
Dec 7, 2021
The documentations states that if the `weight` field is missing, and no explicit missing configuration is provided, a default value of 1 is used. This is incorrect and does not match the implementation of the weighted average aggregator. In this specific case the document is skipped, instead.
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.
This inconsistency has been found while working on #81306.
The documentations states that if the
weightfield is missing, and noexplicit missing configuration is provided, a default value of 1 is used.
This is incorrect and does not match the implementation of the weighted
average aggregator. In this specific case the document is skipped, instead.