-
Notifications
You must be signed in to change notification settings - Fork 0
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.
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
Adding weighted average documentation page #5
base: integ/weighted_average
Are you sure you want to change the base?
Conversation
Signed-off-by: Mitchell Gale <Mitchell.Gale@improving.com>
Signed-off-by: Mitchell Gale <Mitchell.Gale@improving.com>
Signed-off-by: Mitchell Gale <Mitchell.Gale@improving.com>
"hits": [] | ||
}, | ||
"aggregations": { | ||
"Weighted_average_response": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I guess all goes lowercase
"Weighted_average_response": { | |
"weighted_average_response": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This shouldn't matter as it is the name of the result field specified by the query. But for consistency's sake, yes it should be lower case.
{ | ||
"size": 0, | ||
"aggs": { | ||
"Weighted_average_response": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
same
"Weighted_average_response": { | |
"weighted_average_response": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please test rendering formula on the dark theme.
The `weighted average` metric is a multi-value metric aggregations that returns the weighted average value. Weighted average can be used when calculating grades for students, where various assignments and exams make-up the final grade of 100%. | ||
|
||
|
||
A weighted average has two fields, a value and a weight. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A weighted average has two fields, a value and a weight. | |
A weighted average has two fields: a value and a weight. |
|
||
Every value field is applied with the respective value in the weight field. | ||
|
||
![Weighted average formula]({{site.url}}{{site.baseurl}}/images/aggregations/metric/weighted-average.png) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm a bit worried that this causes some inconsistency with size and font from existing formulas like https://github.com/opensearch-project/documentation-website/pull/6808/files
"hits": [] | ||
}, | ||
"aggregations": { | ||
"Weighted_average_response": { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This shouldn't matter as it is the name of the result field specified by the query. But for consistency's sake, yes it should be lower case.
Signed-off-by: Guian Gumpac <guian.gumpac@improving.com>
Description
Adds documentation page for weighted average
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.