Skip to content

Commit 413f74f

Browse files
New state diagram for monitoring status
1 parent fa3a04f commit 413f74f

File tree

3 files changed

+42
-6
lines changed

3 files changed

+42
-6
lines changed

md-docs/stylesheets/extra.css

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,4 +34,8 @@
3434

3535
.nice-list ul{
3636
list-style-type: circle;
37-
}
37+
}
38+
39+
.mermaid {
40+
text-align: center;
41+
}

md-docs/user_guide/model.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,20 @@
1-
# Model
1+
# Model
2+
3+
4+
5+
6+
[//]: # ()
7+
[//]: # ()
8+
[//]: # (What is additional probabilistic output?)
9+
10+
[//]: # ()
11+
[//]: # (What is metric?)
12+
13+
[//]: # ()
14+
[//]: # (What is suggestion type?)
15+
16+
[//]: # ()
17+
[//]: # (What is retraining cost?)
18+
19+
[//]: # ()
20+
[//]: # (What is retraining trigger?)

md-docs/user_guide/monitoring/index.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -121,10 +121,23 @@ All the entities being monitored are associated with a status, which can be one
121121
The following diagram illustrates the possible transitions between the statuses.
122122
Each transition is triggered by a [Detection Event] and the status of the entity is updated accordingly.
123123

124-
<figure markdown style="width: 100%">
125-
![Drift score](../../imgs/monitoring/states.svg)
126-
<figcaption>Monitoring status state diagram</figcaption>
127-
</figure>
124+
```mermaid
125+
stateDiagram-v2
126+
127+
[*] --> OK : Initial State
128+
129+
OK --> WARNING : Warning On
130+
WARNING --> OK : Set new reference
131+
WARNING --> OK : Warning Off
132+
133+
134+
WARNING --> DRIFT : Drift On
135+
DRIFT --> WARNING : Drift Off
136+
137+
DRIFT --> OK : Set new reference
138+
DRIFT --> OK : Drift Off
139+
```
140+
128141

129142
Notice that a Drift OFF event can either bring the entity back to the `OK` status or to the `WARNING` status,
130143
depending on the velocity of the change and the monitoring algorithm's sensitivity. The same applies

0 commit comments

Comments
 (0)