feat: document new anomaly detection syntax (#683)

* document new anomaly detection syntax

* lint

* fix redirect

* update navigation

* fix nav

* document optional model configurations

* format update

* Apply suggestions from code review

Fix Bastien's feedbacks

Co-authored-by: Bastien Boutonnet <[email protected]>

* first changes

* Edited content for style and organization a bit; added to changelog

* Updated nearly all instances of anomaly score to anomaly detection

* refactor parameter names

* add AD scenerios and potential solutions

* touched up an errant style remnant

* add dealing with very tight confidence intervals

* Add feedback process scenerio

* Explain coverage with layman approach and change the header format for mape and coverage

* small update on header

* tuning execution time

* Edited new content for style

* Corrections and clarifications

* Adjusted list for overdue updates.

* A few adjustments to address comments

* Fix the feedbacks of Titus

* fix insensitive detection graphs and explanation

* fix anomaly detection docs example for feedbacks

* typo fix

* Edits to a few older sections

* Small edits for style, wording.

* Removed "not supported by soda core", updated changelog date

* feat: takeover guide from anomaly score to anomaly detection (#703)

* takeover guide from anomaly score to anomaly detection

* Update soda-cl/anomaly-detection.md

Bastien's feedback

Co-authored-by: Bastien Boutonnet <[email protected]>

* Update soda-cl/anomaly-detection.md

Bastien's feedback

Co-authored-by: Bastien Boutonnet <[email protected]>

* Change header

* simplify the transition description

* Edits for style

---------

Co-authored-by: Bastien Boutonnet <[email protected]>
Co-authored-by: Janet Revell <[email protected]>

* feat: support built in prophet public holidays docs (#701)

* document built in holidays

* update country holiday doc and syntax

* edits for style

---------

Co-authored-by: Janet Revell <[email protected]>

* Removed short link refs

* adjusted date in docs changelog

* feat: document severity level parameters (#704)

* document severity level parameters

* Minor edits for language style

* fix Bastiens feedback

* minor edits

---------

Co-authored-by: Janet Revell <[email protected]>

* Fix migration guide (#707)

* improve migration guide

* Edits for language style

* updates for style

---------

Co-authored-by: Janet Revell <[email protected]>

---------

Co-authored-by: Bastien Boutonnet <[email protected]>
Co-authored-by: Janet Revell <[email protected]>

Author: 3 people

_data/nav.yml

@@ -128,7 +128,9 @@
     page: soda-cl/optional-config.md
   - subtitle: Troubleshoot SodaCL
     page: soda-cl/troubleshoot.md
-  - subtitle: Anomaly score checks
+  - subtitle: Anomaly detection checks
+    page: soda-cl/anomaly-detection.md
+  - subtitle: Anomaly score checks (Deprecated)
     page: soda-cl/anomaly-score.md
   - subtitle: Check template
     page: soda-cl/check-template.md

_includes/banner-deprecated.md

@@ -0,0 +1,5 @@
+<div class="info">
+  <span class="closebtn" onclick="this.parentElement.style.display='none';">&times;</span>
+  ⚠️ The anomaly score check is deprecated, replaced by <a href="https://docs.soda.com/soda-cl/anomaly-detection.html">anomaly detection check</a>. <br /><br />
+  Existing anomaly score checks continue to function, though Soda recommends you replace anomaly score with anomaly detection checks.
+</div>

_includes/check-suggest.md

@@ -54,12 +54,12 @@ checks for dataset_A:
 #### Add row count checks
 This step adds two checks: one to confirm that the dataset is not empty, and one to ensure that the current row count is not significantly different from the expected row count. Soda determines the expected row count relative to the previous row count value using a time series-based anomaly detection model.
 
-Refer to [Anomaly score checks]({% link soda-cl/anomaly-score.md %}) for more information.
+Refer to [Anomaly detection checks]({% link soda-cl/anomaly-detection.md %}) for more information.
 
 ```yaml
 checks for dataset_A:
   - row_count > 0
-  - anomaly score for row_count < default
+  - anomaly detection for row_count
 ```
 
 #### Add time-based partitioning

_includes/docker-soda-library.md

@@ -1,4 +1,4 @@
-Use Soda's Docker image in which Soda Scientific is pre-installed. You need Soda Scientific to be able to use SodaCL [distribution checks]({% link soda-cl/distribution.md %}) or [anomaly score checks]({% link soda-cl/anomaly-score.md %}).
+Use Soda's Docker image in which Soda Scientific is pre-installed. You need Soda Scientific to be able to use SodaCL [distribution checks]({% link soda-cl/distribution.md %}) or [anomaly detection checks]({% link soda-cl/anomaly-detection.md %}).
 
 1. If you have not already done so, <a href="https://docs.docker.com/get-docker/" target="_blank">install Docker</a> in your local environment. 
 2. From Terminal, run the following command to pull Soda Library's official Docker image; adjust the version to reflect the most [recent release]({% link release-notes/soda-library.md %}).

_includes/group-anomaly.md

@@ -19,7 +19,7 @@ checks for dim_customer:
       checks:
         - average_children > 2:
             name: Average children per gender should be more than 2
-        - anomaly score for average_children < default:
+        - anomaly detection for average_children:
             name: Detect anomaly for average children
         - change for average_children between -5 and 5:
             name: Detect unexpected changes for average children

_includes/scan-output.md

@@ -25,7 +25,7 @@ Scan summary:
         duplicate_count: 0
       missing_count(adjusted_passenger_count) = 0  [PASSED]
         check_value: 0
-      anomaly score for row_count < default  [PASSED]
+      anomaly detection for row_count  [PASSED]
         check_value: 0.0
       Schema Check [PASSED]
 1/9 checks WARNED: 

_includes/troubleshoot-anomaly-check-tbb.md

@@ -1,4 +1,4 @@
-If you have defined an `anomaly score` check and you use an M1 MacOS machine, you may get a`Library not loaded: @rpath/libtbb.dylib` error. This is a known issue in the MacOS community and is caused by issues during the installation of the <a href="https://github.com/facebook/prophet" target="_blank">prophet library</a>. There currently are no official workarounds or releases to fix the problem, but the following adjustments may address the issue.
+If you have defined an `anomaly detection` check and you use an M1 MacOS machine, you may get a`Library not loaded: @rpath/libtbb.dylib` error. This is a known issue in the MacOS community and is caused by issues during the installation of the <a href="https://github.com/facebook/prophet" target="_blank">prophet library</a>. There currently are no official workarounds or releases to fix the problem, but the following adjustments may address the issue.
 
 1. Install `soda-scientific` as per the local environment installation instructions and activate the virtual environment.
 2. Use the following command to navigate to the directory in which the `stan_model` of the `prophet` package is installed in your virtual environment.

assets/images/ad-better-fit-mape.png

@@ -1332,7 +1332,7 @@ profile columns:
 
 #### 5. Check Datasets
 
-When Soda Cloud automatically discovers the datasets in a data source, it prepares automated monitoring checks for each dataset. These checks detect anomalies and monitor schema evolution, corresponding to the SodaCL [anomaly score]({% link soda-cl/anomaly-score.md %}) and [schema]({% link soda-cl/schema.md %}) checks, respectively.
+When Soda Cloud automatically discovers the datasets in a data source, it prepares automated monitoring checks for each dataset. These checks detect anomalies and monitor schema evolution, corresponding to the SodaCL [anomaly detection]({% link soda-cl/anomaly-detection.md %}) and [schema]({% link soda-cl/schema.md %}) checks, respectively.
 
 In the editing panel, specify the datasets that Soda Cloud must include or exclude when preparing automated monitoring checks. The default syntax in the editing panel indicates that Soda will add automated monitoring to all datasets in the data source *except* those with names that begin with `test_`.  The `%` is a wildcard character.
 {% include code-header.html %}