You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: md-docs/user_guide/monitoring/detection_event.md
+5-4Lines changed: 5 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Detection Event
2
2
3
-
A [Detection Event] is raised by the MLCube Platform when a significant change is detected in one of the entities being monitored.
3
+
A [Detection Event] is raised by the ML cube Platform when a significant change is detected in one of the entities being monitored.
4
4
5
5
An event is characterized by the following attributes:
6
6
@@ -10,8 +10,8 @@ An event is characterized by the following attributes:
10
10
the criticality of the detected drift.
11
11
-`monitoring_target`: the [MonitoringTarget] being monitored.
12
12
-`monitoring_metric`: the [MonitoringMetric] that triggered the event, if the event is related to a metric.
13
-
-`model_name`: the name of the model that raised the event.
14
-
-`model_version`: the version of the model that raised the event.
13
+
-`model_name`: the name of the model that raised the event. It's present only if the event is related to a model.
14
+
-`model_version`: the version of the model that raised the event. It's present only if the event is related to a model.
15
15
-`insert_datetime`: the time when the event was raised.
16
16
-`sample_timestamp`: the timestamp of the sample that triggered the event.
17
17
- 'sample_customer_id': the id of the customer that triggered the event.
@@ -23,7 +23,8 @@ You can access the detection events generated by the Platform in two ways:
23
23
24
24
-**SDK**: the [get_detection_events] method can be used to retrieve all detection events for a specific task programmatically.
25
25
-**WebApp**: navigate to the **`Detection `** section located in the task page's sidebar. Here, all detection events are displayed in a table,
26
-
with multiple filtering options available for useful event management.
26
+
with multiple filtering options available for useful event management. Additionally, the latest detection events identified are shown in the Task homepage,
Copy file name to clipboardExpand all lines: md-docs/user_guide/monitoring/index.md
+8-7Lines changed: 8 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,9 +15,9 @@ in turn can have a negative impact on the business.
15
15
Monitoring, also known as __Drift Detection__ in the literature, refers the process of continuously tracking the performance of a model
16
16
and the distribution of the data it is operating on.
17
17
18
-
## How does the MLCube Platform perform Monitoring?
18
+
## How does the ML cube Platform perform Monitoring?
19
19
20
-
The MLCube platform performs monitoring by employing statistical techniques to compare a certain reference (for instance, data used for training or the performance of a model
20
+
The ML cube platform performs monitoring by employing statistical techniques to compare a certain reference (for instance, data used for training or the performance of a model
21
21
on the test set) to incoming production data. If a significant difference is detected, an alarm is raised, signaling that the monitored entity
22
22
is drifting away from the expected behavior and that corrective actions should be taken.
23
23
@@ -34,14 +34,15 @@ and the [Detection Event Rule] sections respectively.
34
34
### Targets and Metrics
35
35
36
36
After explaining why monitoring is so important in modern AI systems and detailing how it is performed in the ML cube Platform,
37
-
we can introduce the concepts of Monitoring Targets and Monitoring Metrics. They both represent quantities that the MLCube Platform monitors, but they differ in their nature.
37
+
we can introduce the concepts of Monitoring Targets and Monitoring Metrics. They both represent quantities that the ML cube Platform monitors, but they differ in their nature.
38
+
They are both automatically defined by the ML cube platform based on the [Task] attributes, such as the Task type and the data structure.
38
39
39
40
#### Monitoring Targets
40
41
41
42
A Monitoring Target is a relevant entity involved in a [Task]. They represent the main quantities monitored by the platform, those whose
42
43
variation can have a significant impact on the AI task success.
43
44
44
-
The MLCube platform supports the following monitoring targets:
45
+
The ML cube platform supports the following monitoring targets:
45
46
46
47
-`INPUT`: the input distribution, $P(X)$.
47
48
-`CONCEPT`: the joint distribution of input and target, $P(X, Y)$.
@@ -72,9 +73,9 @@ Nonetheless, the platform might not support yet all possible combinations. The t
72
73
#### Monitoring Metrics
73
74
74
75
A Monitoring Metric is a generic quantity that can be computed on a Monitoring Target. They enable the monitoring of specific
75
-
aspects of a target, which might help in identifying the root cause of a drift, as well as defining the corrective actions to be taken.
76
+
aspects of an entity, which might help in identifying the root cause of a drift, as well as defining the corrective actions to be taken.
76
77
77
-
The following table display the monitoring metrics supported, along with their monitoring target and the conditions
78
+
The following table displays the monitoring metrics supported, along with their monitoring target and the conditions
78
79
under which they are actually monitored. Notice that also this table is subject to changes, as new metrics will be added.
0 commit comments