docs: add Understanding Your Baseline Period section to ML configuration#22064
Draft
nedi-app[bot] wants to merge 1 commit intomasterfrom
Draft
docs: add Understanding Your Baseline Period section to ML configuration#22064nedi-app[bot] wants to merge 1 commit intomasterfrom
nedi-app[bot] wants to merge 1 commit intomasterfrom
Conversation
Add a new section explaining how to calculate the comparison baseline period for anomaly detection based on ML configuration parameters. Includes the formula, example calculations for default and custom configs, and explanation of how the baseline period affects anomaly detection.
Contributor
There was a problem hiding this comment.
No issues found across 1 file
Confidence score: 5/5
- Automated review surfaced no issues in the provided summaries.
- No files require special attention.
Architecture diagram
sequenceDiagram
participant TSDB as Time-Series Database
participant MLEngine as ML Engine
participant Models as Model Store (N models)
participant Alerter as Alerting System
Note over MLEngine,Models: NEW logic: Total Baseline = (Models per Dim) × (Train Every)
loop Every "train every" interval (e.g., 1h or 3h)
MLEngine->>TSDB: Fetch historical samples (maximum num samples)
TSDB-->>MLEngine: Training data window
MLEngine->>MLEngine: Train new model instance
MLEngine->>Models: CHANGED: Rotate/Update model in pool
Note right of Models: Total pool size = "number of models per dimension"
end
Note over TSDB,Alerter: Anomaly Detection Flow
TSDB->>MLEngine: New data point collected
loop For each model in pool (up to N)
MLEngine->>Models: Query data point against model
Models-->>MLEngine: Individual Anomaly Score
end
alt Consensus reached (All models agree)
MLEngine->>MLEngine: Calculate aggregate Anomaly Score
opt Score > "dimension anomaly score threshold"
MLEngine->>Alerter: Trigger Anomaly Alert
Note over Alerter: Alert context: Validated against<br/>total baseline period
end
else No Consensus
MLEngine->>MLEngine: Suppress false positive
end
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
ml-configuration.mdbaseline_period = number of models per dimension × train everyChanges
Added a new section after "Multiple Models and False Positive Reduction" that:
Audit Context
Session Query (Original):
наш текущий конф:
```
[ml]
enabled = yes
dimension anomaly score threshold = 0.5
number of models per dimension = 6
num samples to smooth = 1
minimum num samples to train = 600
train every = 1h
```
когда приходит алерт об аномалии, как понять, по сравнению с чем пришёл этот алерт? за какой период?
Session Query (English translation):
Our current config:
```
[ml]
enabled = yes
dimension anomaly score threshold = 0.5
number of models per dimension = 6
num samples to smooth = 1
minimum num samples to train = 600
train every = 1h
```
When an anomaly alert comes, how to understand what this alert is compared against? For what period?
Decision Verdict: Surgical documentation edit to add a formula and explanation for calculating the ML anomaly detection baseline period based on configuration parameters.
Summary by cubic
Adds an "Understanding Your Baseline Period" section to
ml-configuration.mdto explain the time window anomaly alerts are compared against. Includes a simple formula and examples to map ML config to a concrete baseline period.baseline_period = number of models per dimension × train every.Written for commit 72df1a3. Summary will update on new commits.