[ML] Add categorizer stats ML result type #57978
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
This type of result will store stats about how well categorization is performing. When per-partition categorization is in use, separate documents will be written for every partition so that it is possible to see if categorization is working well for some partitions but not others. This PR is a minimal implementation to allow the C++ side changes to be made. More Java side changes related to per-partition categorization will be in followup PRs. However, even in the long term I do not see a major benefit in introducing dedicated APIs for querying categorizer stats. Like forecast request stats the categorizer stats can be read directly from the job's results alias.
|
Pinging @elastic/ml-core (:ml) |
benwtrent
approved these changes
Jun 11, 2020
...main/java/org/elasticsearch/xpack/core/ml/job/process/autodetect/state/CategorizerStats.java
Outdated
Show resolved
Hide resolved
Comment on lines
+97
to
+102
| this.categorizedDocCount = categorizedDocCount; | ||
| this.totalCategoryCount = totalCategoryCount; | ||
| this.frequentCategoryCount = frequentCategoryCount; | ||
| this.rareCategoryCount = rareCategoryCount; | ||
| this.deadCategoryCount = deadCategoryCount; | ||
| this.failedCategoryCount = failedCategoryCount; |
There was a problem hiding this comment.
We don't check that all of these are > 0. This is probably OK since we are getting this data from C++ and there is an implicit trust.
There was a problem hiding this comment.
Yes, good point. This is dodgy when we're using VLong serialization. It means someone can DoS us by updating a document to contain a negative number.
This same problem applies to most of our other results classes too, so I think it's best to deal with it in a separate PR.
Like you say, the C++ won't send negative values for unsigned counters, so it's not a likely problem.
x-pack/plugin/ml/src/main/java/org/elasticsearch/xpack/ml/job/results/AutodetectResult.java
Outdated
Show resolved
Hide resolved
x-pack/plugin/ml/src/main/java/org/elasticsearch/xpack/ml/job/results/AutodetectResult.java
Outdated
Show resolved
Hide resolved
Co-authored-by: Benjamin Trent <[email protected]>
droberts195
added a commit
to droberts195/elasticsearch
that referenced
this pull request
Jun 11, 2020
This type of result will store stats about how well categorization is performing. When per-partition categorization is in use, separate documents will be written for every partition so that it is possible to see if categorization is working well for some partitions but not others. This PR is a minimal implementation to allow the C++ side changes to be made. More Java side changes related to per-partition categorization will be in followup PRs. However, even in the long term I do not see a major benefit in introducing dedicated APIs for querying categorizer stats. Like forecast request stats the categorizer stats can be read directly from the job's results alias. Backport of elastic#57978
droberts195
added a commit
to droberts195/elasticsearch
that referenced
this pull request
Jun 11, 2020
After merging elastic#58001 the BWC constants added in elastic#57978 are no longer needed.
droberts195
added a commit
that referenced
this pull request
Jun 12, 2020
This type of result will store stats about how well categorization is performing. When per-partition categorization is in use, separate documents will be written for every partition so that it is possible to see if categorization is working well for some partitions but not others. This PR is a minimal implementation to allow the C++ side changes to be made. More Java side changes related to per-partition categorization will be in followup PRs. However, even in the long term I do not see a major benefit in introducing dedicated APIs for querying categorizer stats. Like forecast request stats the categorizer stats can be read directly from the job's results alias. Backport of #57978
droberts195
added a commit
that referenced
this pull request
Jun 12, 2020
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 type of result will store stats about how well categorization
is performing. When per-partition categorization is in use, separate
documents will be written for every partition so that it is possible
to see if categorization is working well for some partitions but not
others.
This PR is a minimal implementation to allow the C++ side changes to
be made. More Java side changes related to per-partition
categorization will be in followup PRs. However, even in the long
term I do not see a major benefit in introducing dedicated APIs for
querying categorizer stats. Like forecast request stats the
categorizer stats can be read directly from the job's results alias.