Add feature direction to AD docs #9137
Conversation
Signed-off-by: Amit Galitzky <amgalitz@amazon.com>
amitgalitz
requested review from
kolchfa-aws,
Naarcha-AWS,
AMoo-Miki,
natebower,
dlvenable and
epugh
as code owners
|
Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged. Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer. When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review. |
kolchfa-aws
added
release-notes
_observing-your-data/ad/index.md
Outdated
| @@ -201,7 +205,7 @@ Be cautious when imputing extensively missing data, as excessive gaps can compro | |||
|
|
|||
| ### Suppressing anomalies with threshold-based rules | |||
|
|
|||
| In the **Advanced settings** pane, you can suppress anomalies by setting rules that define acceptable differences between the expected and actual values, either as an absolute value or a relative percentage. This helps reduce false anomalies caused by minor fluctuations, allowing you to focus on significant deviations. | |||
| In the Feature selection pane, you can suppress anomalies by setting rules that define acceptable differences between the expected and actual values, either as an absolute value or a relative percentage. This helps reduce false anomalies caused by minor fluctuations, allowing you to focus on significant deviations. | |||
There was a problem hiding this comment.
Please move the suppression rules outside of its own to feature section. that makes it easier to find.
There was a problem hiding this comment.
you also need to update example snapshot in my example.
There was a problem hiding this comment.
I removed this:
"Ensure that a feature, for example, logVolume, is properly defined in your model. Suppression rules are tied to specific features."
There is no photo snapshot currently in the docs but do you mean removing this:
Ignore anomalies for feature logVolume when the actual value is no more than 30% above the expected value.
Ignore anomalies for feature logVolume when the actual value is no more than 30% below the expected value.
and replace with screenshot of current UI?
There was a problem hiding this comment.
yeah, i think that would be more straightforward using screenshot.
There was a problem hiding this comment.
added 2 screenshots, still kept this wording though.
First screenshot has entire feature configuration and second just a zoom in of the suppression rules, let me know if you think its too much
There was a problem hiding this comment.
In images/anomaly-detection/add-suppression-rules-absolute.png, you need use "Units" in both rules.
Signed-off-by: Amit Galitzky <amgalitz@amazon.com>
Signed-off-by: Amit Galitzky <amgalitz@amazon.com>
|
@amitgalitz: Looks good. Made some small adjustments. Can you look them over and make sure that the changes are still technically accurate? |
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
|
@Naarcha-AWS The change looks good. |
|
@natebower: This is ready for your review. |
Naarcha-AWS
added
5 - Editorial review
There was a problem hiding this comment.
@Naarcha-AWS @amitgalitz Please see my comments and changes and tag me for approval when addressed. Thanks!
_observing-your-data/ad/index.md
Outdated
| - Ignore anomalies when the actual value is no more than 30% above the expected value. | ||
| - Ignore anomalies when the actual value is no more than 30% below the expected value. | ||
|
|
||
| The following image shows where to set the relative deviation percentage settings: |
There was a problem hiding this comment.
Name what is shown in the image: "The following image shows the X page/window/pane, where you can set the relative deviation percentage settings:"
_observing-your-data/ad/index.md
Outdated
| - Ignore anomalies when the actual value is no more than 10000 above the expected value. | ||
| - Ignore anomalies when the actual value is no more than 10000 below the expected value. | ||
|
|
||
| The following image shows where to set the absolute threshold settings: |
There was a problem hiding this comment.
Name what is shown in the image: "The following image shows the X page/window/pane, where you can set the absolute threshold settings:"
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Co-authored-by: Nathan Bower <nbower@amazon.com> Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Signed-off-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com>
Description
Adding description so users know they can also select a feature direction when configuring a feature.
Issues Resolved
Closes #9118
Version
2.19
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.