dotnet / dotnet/machinelearning

Help text for fields are in the source code yet are not present here

Open
#7,041 0 comments 0 reactions 0 assignees View on GitHub
area-TimeSeries documentation untriaged
Dominant language
C#
Stars
9.4k
Forks
2k
Avg merge
2d 20h
Merged PRs (30d)
11

Description

There is help provided for these fields directly in the source code, I wonder why it wasn't used even in this templated topic

- Threshold = "The threshold to determine anomaly, score larger than the threshold is considered as anomaly."
- BatchSize = "The number of data points to be detected in each batch. It should be at least 12. Set this parameter to -1 to detect anomaly on the entire series."
- Sensitivity = "This parameter is used in AnomalyAndMargin mode the determine the range of the boundaries."
- DetectMode = "Specify the detect mode as one of AnomalyOnly, AnomalyAndExpectedValue and AnomalyAndMargin."
- Period = "If there is circular pattern in the series, set this value to the number of points in one cycle."
- DeseasonalityMode = "Specify the deseasonality mode as one of stl, mean and median."

---
#### Document Details

⚠ *Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.*

* ID: 3bf2c1e4-4042-be7d-c072-8ee9e0690e48
* Version Independent ID: 0406e897-a227-2397-d4e1-fde038e743c5
* Content: [SrCnnEntireAnomalyDetectorOptions.Threshold Field (Microsoft.ML.TimeSeries)](https://learn.microsoft.com/en-us/dotnet/api/microsoft.ml.timeseries.srcnnentireanomalydetectoroptions.threshold?view=ml-dotnet-2.0.0&source=docs)
* Content Source: [dotnet/xml/Microsoft.ML.TimeSeries/SrCnnEntireAnomalyDetectorOptions.xml](https://github.com/dotnet/ml-api-docs/blob/live/dotnet/xml/Microsoft.ML.TimeSeries/SrCnnEntireAnomalyDetectorOptions.xml)
* Service: **dotnet-ml-api**
* GitHub Login: @natke
* Microsoft Alias: **nakersha**

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.