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

Adds anomaly detection FAQ items to the Troubleshooting page #2714

Merged
merged 8 commits into from
Jun 17, 2024

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented May 16, 2024

Overview

This PR adds FAQ items to the Troubleshooting page.

Preview

Troubleshooting and FAQ

@szabosteve szabosteve added :ml v8.13 backport-8.13 Automated backport with mergify v8.14 v.8.15 backport-8.14 Automated backport with mergify labels May 16, 2024
@szabosteve szabosteve requested a review from a team as a code owner May 16, 2024 12:13
Copy link

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@szabosteve szabosteve requested a review from valeriy42 May 16, 2024 14:04
@szabosteve szabosteve marked this pull request as draft May 16, 2024 14:05
@szabosteve szabosteve changed the title Adds anomaly detection FAQ page Adds anomaly detection FAQ items to the Troubleshooting page May 21, 2024
@szabosteve szabosteve marked this pull request as ready for review May 21, 2024 11:59
Copy link
Contributor

@valeriy42 valeriy42 left a comment

Choose a reason for hiding this comment

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

Hi Istvan! Sorry for the delay. I finally managed to review the page and make some suggestions.

Comment on lines 123 to 136

As model predictions, 95% confidence intervals, and actual values in
documents in an index (if you enabled model plot) are available, you can use
standard measures to assess prediction accuracy, interval calibration and so on.
Aggregations can be used to compute these statistics. This might be useful if
you would like to monitor data drifts; however, there are ways to automatically
adapt to changing data characteristics.

The purpose of {anomaly-detect} is to achieve the best ranking of periods where
an anomaly happened. A useful way to evaluate this is to keep track of real
incidents and see how well they correlate with the predictions of
{anomaly-detect}. In practice, it is usually unambiguous qualitatively whether
{anomaly-detect} is working well.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think, something is missing here. Let's catch up over zoom and see how to clarify this part.

Copy link
Contributor

@valeriy42 valeriy42 left a comment

Choose a reason for hiding this comment

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

LGTM. Great work, @szabosteve, on translating my technobabble. This FAQ will be of great value to the customers. 🚀

@szabosteve szabosteve merged commit 3e1d41c into elastic:main Jun 17, 2024
3 checks passed
@szabosteve szabosteve deleted the ad-faq branch June 17, 2024 12:44
mergify bot pushed a commit that referenced this pull request Jun 17, 2024
* Adds anomaly detection FAQ.

* Adds more FAQ items.

* Adds items to the AD FAQ page.

* Further edits.

* Fixes bulleted lists.

* [DOCS] Rephrase intro.

* Adjusts structure.

* [DOCS] Addresses feedback.

(cherry picked from commit 3e1d41c)
mergify bot pushed a commit that referenced this pull request Jun 17, 2024
* Adds anomaly detection FAQ.

* Adds more FAQ items.

* Adds items to the AD FAQ page.

* Further edits.

* Fixes bulleted lists.

* [DOCS] Rephrase intro.

* Adjusts structure.

* [DOCS] Addresses feedback.

(cherry picked from commit 3e1d41c)
szabosteve added a commit that referenced this pull request Jun 17, 2024
…2736)


Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>
szabosteve added a commit that referenced this pull request Jun 17, 2024
…2735)

Co-authored-by: István Zoltán Szabó <istvan.szabo@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-8.13 Automated backport with mergify backport-8.14 Automated backport with mergify :ml v8.13 v8.14 v.8.15
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants