Skip to content
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

Change single size description and fix related places #76

Merged
merged 2 commits into from
Aug 26, 2021

Conversation

kaituo
Copy link
Collaborator

@kaituo kaituo commented Aug 26, 2021

Description

This PR changed the shingle size description. Specifically,

  1. I replaced window size with shingle size as we used shingle in various places of https://opensearch.org/docs/monitoring-plugins/ad/index/, public API, and our code. To be consistent, I changed to shingle.
  2. We discourage the use of shingle size 1. AD with 1 value is not well defined, attribution is not useful (100% always) and expected value is not well defined. The recommendation makes the result more useful to the customer.
  3. Updated the range of shingle size.
  4. Changed to have one default shingle size 8. Don't differentiate HCAD and single-stream detectors.

Testing done:

  1. unit and e2e tests pass.
  2. Manually checked the changed text showed correctly.

Before:
shingleSize_before

After:
shingleSize_after

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

kaituo added 2 commits August 25, 2021 14:57
This PR changed the shingle size description.  Specifically,

1) I replaced window size with shingle size as we used shingle in various places of  https://opensearch.org/docs/monitoring-plugins/ad/index/ and our code.  To be consistent, I changed to shingle.
2) We discourage the use of shingle size 1.  AD with 1 value is not well defined, attribution is not useful (100% always) and expected value is not well defined. The recommendation makes the result more useful to the customer.
3) Updated the range of shingle size.
4) Changed to have one default shingle size 8.  Don't differentiate HCAD and single-stream detectors.

Testing done:
1. unit and e2e tests pass.
2. Manually checked the changed text showed correctly.
@kaituo kaituo requested a review from ohltyler August 26, 2021 18:15
@kaituo kaituo changed the title Size Change single size description and fix related places Aug 26, 2021
Copy link
Member

@ohltyler ohltyler left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM!

@kaituo kaituo merged commit 320b2b9 into opensearch-project:main Aug 26, 2021
ohltyler pushed a commit to ohltyler/anomaly-detection-dashboards-plugin-1 that referenced this pull request Sep 1, 2021
…oject#76)

* Change single size description and fix related places

This PR changed the shingle size description.  Specifically,

1) I replaced window size with shingle size as we used shingle in various places of  https://opensearch.org/docs/monitoring-plugins/ad/index/ and our code.  To be consistent, I changed to shingle.
2) We discourage the use of shingle size 1.  AD with 1 value is not well defined, attribution is not useful (100% always) and expected value is not well defined. The recommendation makes the result more useful to the customer.
3) Updated the range of shingle size.
4) Changed to have one default shingle size 8.  Don't differentiate HCAD and single-stream detectors.

Testing done:
1. unit and e2e tests pass.
2. Manually checked the changed text showed correctly.
ohltyler pushed a commit that referenced this pull request Sep 1, 2021
* Change single size description and fix related places

This PR changed the shingle size description.  Specifically,

1) I replaced window size with shingle size as we used shingle in various places of  https://opensearch.org/docs/monitoring-plugins/ad/index/ and our code.  To be consistent, I changed to shingle.
2) We discourage the use of shingle size 1.  AD with 1 value is not well defined, attribution is not useful (100% always) and expected value is not well defined. The recommendation makes the result more useful to the customer.
3) Updated the range of shingle size.
4) Changed to have one default shingle size 8.  Don't differentiate HCAD and single-stream detectors.

Testing done:
1. unit and e2e tests pass.
2. Manually checked the changed text showed correctly.
@ohltyler ohltyler added enhancement New feature or request v1.1.0 Version 1.1.0 labels Sep 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request v1.1.0 Version 1.1.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants